OpenAPI - Distinguish between stored procedure parameters and result set columns (#1551)

## Why make this change?

- Closes #1509

## What is this change?

- The OpenApiDocumentor service now correctly distinguishes between
input parameters and result set columns when documenting a stored
procedures REST endpoint. Previously, only the result set columns were
resolved. As a result, the OpenApi document that is generated now shows
input parameters as fields to be used in the request bodies of POST,
PUT, and PATCH. (GET and DELETE have no request bodies).

## How was this tested?

- [x] Integration Tests - Added tests with additional stored procedures
in our sql deployment script which demonstrates how parameters and
output result set columns (and their JSON data types) are resolved and
included in the open api doc.

## OpenAPI document example 
An example OpenAPI document which helps visualize how the parsing works.
Irrelevant fields were removed.
```json
{
    "openapi": "3.0.1",
    "paths": {
        "/sp1": {
            "get": {"..."},
            "post": {
                "tags": [
                    "sp1"
                ],
                "description": "Executes a stored procedure.",
                "requestBody": {
                    "content": {
                        "application/json": {
                            "schema": {
                                "$ref": "#/components/schemas/sp1_sp_request"
                            }
                        }
                    },
                    "required": true
                },
                "responses": {
                    "201": {
                        "description": "Created",
                        "content": {
                            "application/json": {
                                "schema": {
                                    "properties": {
                                        "value": {
                                            "type": "array",
                                            "items": {
                                                "$ref": "#/components/schemas/sp1_sp_response"
                                            }
                                        }
                                    }
                                }
                            }
                        }
                    },
                    "400": {
                        "description": "BadRequest"
                    }
                }
            }
		}
    },
    "components": {
        "schemas": {
            "sp1_sp_request": {
                "type": "object",
                "properties": {
                    "inputName": {
                        "type": "string",
                        "format": ""
                    }
                }
            },
            "sp1_sp_response": {
                "type": "object",
                "properties": {
                    "outputName": {
                        "type": "string",
                        "format": ""
                    }
                }
            }
        }
    }
}
```

---------

Co-authored-by: Aniruddh Munde <[email protected]>

Author: seantleonard

src/Core/Services/OpenAPI/IOpenApiDocumentor.cs

@@ -3,7 +3,7 @@
 
 using System.Diagnostics.CodeAnalysis;
 
-namespace Azure.DataApiBuilder.Core.Services.OpenAPI
+namespace Azure.DataApiBuilder.Core.Services
 {
     /// <summary>
     /// Interface for the service which generates and provides the OpenAPI description document

src/Core/Services/OpenAPI/OpenApiDocumentor.cs

@@ -25,7 +25,8 @@
     <PackageVersion Include="Microsoft.NET.Test.Sdk" Version="17.3.2" />
     <PackageVersion Include="Microsoft.OData.Edm" Version="7.12.5" />
     <PackageVersion Include="Microsoft.OData.Core" Version="7.12.5" />
-    <PackageVersion Include="Microsoft.OpenApi" Version="1.6.3" />
+    <PackageVersion Include="Microsoft.OpenApi" Version="1.6.5" />
+    <PackageVersion Include="Microsoft.OpenApi.Readers" Version="1.6.5" />
     <PackageVersion Include="Moq" Version="4.18.2" />
     <PackageVersion Include="MSTest.TestAdapter" Version="3.0.2" />
     <PackageVersion Include="MSTest.TestFramework" Version="3.0.2" />

src/Directory.Packages.props

@@ -18,6 +18,8 @@
     <PackageReference Include="Microsoft.AspNetCore.Mvc.Testing" />
     <PackageReference Include="Microsoft.AspNetCore.TestHost" />
     <PackageReference Include="Microsoft.NET.Test.Sdk" />
+    <PackageReference Include="Microsoft.OpenApi" />
+    <PackageReference Include="Microsoft.OpenApi.Readers" />
     <PackageReference Include="Moq" />
     <PackageReference Include="MSTest.TestAdapter" />
     <PackageReference Include="MSTest.TestFramework" />
@@ -77,6 +79,7 @@
   <ItemGroup>
     <ProjectReference Include="..\Auth\Azure.DataApiBuilder.Auth.csproj" />
     <ProjectReference Include="..\Config\Azure.DataApiBuilder.Config.csproj" />
+    <ProjectReference Include="..\Core\Azure.DataApiBuilder.Core.csproj" />
     <ProjectReference Include="..\Service\Azure.DataApiBuilder.Service.csproj" />
   </ItemGroup>
 

src/Service.Tests/Azure.DataApiBuilder.Service.Tests.csproj

@@ -27,6 +27,7 @@
 using Azure.DataApiBuilder.Service.Controllers;
 using Azure.DataApiBuilder.Service.Exceptions;
 using Azure.DataApiBuilder.Service.Tests.Authorization;
+using Azure.DataApiBuilder.Service.Tests.OpenApiIntegration;
 using Azure.DataApiBuilder.Service.Tests.SqlTests;
 using HotChocolate;
 using Microsoft.AspNetCore.TestHost;
@@ -1709,7 +1710,7 @@ public async Task OpenApi_EntityLevelRestEndpoint()
             using TestServer server = new(Program.CreateWebHostBuilder(args));
             using HttpClient client = server.CreateClient();
             // Setup and send GET request
-            HttpRequestMessage readOpenApiDocumentRequest = new(HttpMethod.Get, $"{RestRuntimeOptions.DEFAULT_PATH}/{Core.Services.OpenAPI.OpenApiDocumentor.OPENAPI_ROUTE}");
+            HttpRequestMessage readOpenApiDocumentRequest = new(HttpMethod.Get, $"{RestRuntimeOptions.DEFAULT_PATH}/{OpenApiDocumentor.OPENAPI_ROUTE}");
             HttpResponseMessage response = await client.SendAsync(readOpenApiDocumentRequest);
 
             // Parse response metadata

src/Service.Tests/Configuration/ConfigurationTests.cs

@@ -9,7 +9,7 @@
 using Azure.DataApiBuilder.Service.Models;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
-namespace Azure.DataApiBuilder.Service.Tests.OpenApiDocumentor;
+namespace Azure.DataApiBuilder.Service.Tests.OpenApiIntegration;
 
 /// <summary>
 /// Validates TypeHelper converters return expected results.

src/Service.Tests/OpenApiDocumentor/CLRtoJsonValueTypeUnitTests.cs

@@ -1,7 +1,7 @@
 // Copyright (c) Microsoft Corporation.
 // Licensed under the MIT License.
 
-namespace Azure.DataApiBuilder.Service.Tests
+namespace Azure.DataApiBuilder.Service.Tests.OpenApiIntegration
 {
     public class OpenApiDocumentorConstants
     {

src/Service.Tests/OpenApiDocumentor/OpenApiDocumentorConstants.cs

@@ -8,7 +8,6 @@
 using Azure.DataApiBuilder.Config.ObjectModel;
 using Azure.DataApiBuilder.Core.Models;
 using Azure.DataApiBuilder.Core.Services;
-using Azure.DataApiBuilder.Core.Services.OpenAPI;
 using Azure.DataApiBuilder.Service.Exceptions;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Extensions;