.Net OpenAPI -> OpenApi Naming Change (#4100)

Resolves #3765
microsoft · Dec 9, 2023 · 78a4333 · 78a4333
1 parent 1c1da87
commit 78a4333
Show file tree

Hide file tree

Showing 49 changed files with 13 additions and 13 deletions.
diff --git a/dotnet/README.md b/dotnet/README.md
@@ -147,7 +147,7 @@ Other SK packages available at nuget.org:
    OpenXML, etc.
 4. **Microsoft.SemanticKernel.Plugins.MsGraph**: Microsoft Graph Plugin: access your
    tenant data, schedule meetings, send emails, etc.
-5. **Microsoft.SemanticKernel.Plugins.OpenAPI**: OpenAPI Plugin.
+5. **Microsoft.SemanticKernel.Plugins.OpenApi**: OpenAPI Plugin.
 6. **Microsoft.SemanticKernel.Plugins.Web**: Web Plugin: search the web, download
    files, etc.
 7. **Microsoft.SemanticKernel.Reliability.Polly**: Extension for http resiliency.
diff --git a/dotnet/SK-dotnet.sln b/dotnet/SK-dotnet.sln
@@ -48,7 +48,7 @@ Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "nuget", "nuget", "{F4243136
 		nuget\NUGET.md = nuget\NUGET.md
 	EndProjectSection
 EndProject
-Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Functions.OpenAPI", "src\Functions\Functions.OpenAPI\Functions.OpenAPI.csproj", "{F2A1F81E-700E-4C0E-B021-B9EF29AA20BD}"
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "Functions.OpenApi", "src\Functions\Functions.OpenApi\Functions.OpenApi.csproj", "{F2A1F81E-700E-4C0E-B021-B9EF29AA20BD}"
 EndProject
 Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "connectors", "connectors", "{0247C2C9-86C3-45BA-8873-28B0948EDC0C}"
 EndProject

diff --git a/dotnet/samples/KernelSyntaxExamples/KernelSyntaxExamples.csproj b/dotnet/samples/KernelSyntaxExamples/KernelSyntaxExamples.csproj
@@ -60,7 +60,7 @@
     <ProjectReference Include="..\..\src\SemanticKernel.Abstractions\SemanticKernel.Abstractions.csproj" />
     <ProjectReference Include="..\..\src\Plugins\Plugins.Core\Plugins.Core.csproj" />
     <ProjectReference Include="..\..\src\Plugins\Plugins.Memory\Plugins.Memory.csproj" />
-    <ProjectReference Include="..\..\src\Functions\Functions.OpenAPI\Functions.OpenAPI.csproj" />
+    <ProjectReference Include="..\..\src\Functions\Functions.OpenApi\Functions.OpenApi.csproj" />
     <ProjectReference Include="..\..\src\Functions\Functions.Grpc\Functions.Grpc.csproj" />
     <ProjectReference Include="..\..\src\Connectors\Connectors.Memory.Qdrant\Connectors.Memory.Qdrant.csproj" />
     <ProjectReference Include="..\..\src\Plugins\Plugins.Web\Plugins.Web.csproj" />

diff --git a/dotnet/samples/KernelSyntaxExamples/Plugins/JiraPlugin/README.md b/dotnet/samples/KernelSyntaxExamples/Plugins/JiraPlugin/README.md
@@ -1,6 +1,6 @@
 # Jira Open API Schema
 
-We have our own curated version of the Jira Open API schema because the one available online 
-at https://raw.githubusercontent.com/microsoft/PowerPlatformConnectors/dev/certified-connectors/JIRA/apiDefinition.swagger.json, 
-doesn't follow OpenAPI specification for all of its operations. For example CreateIssueV2, its body param does not describe properties 
-and so we can't build the body automatically.
+We have our own curated version of the Jira Open API schema because the one available online
+at https://raw.githubusercontent.com/microsoft/PowerPlatformConnectors/dev/certified-connectors/JIRA/apiDefinition.swagger.json,
+doesn't follow OpenAPI specification for all of its operations. For example CreateIssueV2, its body param does not describe properties
+and so we can't build the body automatically.
diff --git a/...ation/AuthenticateRequestAsyncCallback.cs → ...ation/AuthenticateRequestAsyncCallback.cs b/...ation/AuthenticateRequestAsyncCallback.cs → ...ation/AuthenticateRequestAsyncCallback.cs
diff --git a/...entication/BasicAuthenticationProvider.cs → ...entication/BasicAuthenticationProvider.cs b/...entication/BasicAuthenticationProvider.cs → ...entication/BasicAuthenticationProvider.cs
diff --git a/...ntication/BearerAuthenticationProvider.cs → ...ntication/BearerAuthenticationProvider.cs b/...ntication/BearerAuthenticationProvider.cs → ...ntication/BearerAuthenticationProvider.cs
diff --git a/...ntication/CustomAuthenticationProvider.cs → ...ntication/CustomAuthenticationProvider.cs b/...ntication/CustomAuthenticationProvider.cs → ...ntication/CustomAuthenticationProvider.cs
diff --git a/.../InteractiveMsalAuthenticationProvider.cs → .../InteractiveMsalAuthenticationProvider.cs b/.../InteractiveMsalAuthenticationProvider.cs → .../InteractiveMsalAuthenticationProvider.cs
diff --git a/...nAPI/Authentication/OAuthTokenResponse.cs → ...nApi/Authentication/OAuthTokenResponse.cs b/...nAPI/Authentication/OAuthTokenResponse.cs → ...nApi/Authentication/OAuthTokenResponse.cs
diff --git a/...ntication/OpenAIAuthenticationProvider.cs → ...ntication/OpenAIAuthenticationProvider.cs b/...ntication/OpenAIAuthenticationProvider.cs → ...ntication/OpenAIAuthenticationProvider.cs
diff --git a/...unctions.OpenAPI/Authentication/README.md → ...unctions.OpenApi/Authentication/README.md b/...unctions.OpenAPI/Authentication/README.md → ...unctions.OpenApi/Authentication/README.md
diff --git a/...ns.OpenAPI/Builders/QueryStringBuilder.cs → ...ns.OpenApi/Builders/QueryStringBuilder.cs b/...ns.OpenAPI/Builders/QueryStringBuilder.cs → ...ns.OpenApi/Builders/QueryStringBuilder.cs
diff --git a/...lization/ArrayParameterValueSerializer.cs → ...lization/ArrayParameterValueSerializer.cs b/...lization/ArrayParameterValueSerializer.cs → ...lization/ArrayParameterValueSerializer.cs
diff --git a/...alization/FormStyleParameterSerializer.cs → ...alization/FormStyleParameterSerializer.cs b/...alization/FormStyleParameterSerializer.cs → ...alization/FormStyleParameterSerializer.cs
diff --git a/.../PipeDelimitedStyleParameterSerializer.cs → .../PipeDelimitedStyleParameterSerializer.cs b/.../PipeDelimitedStyleParameterSerializer.cs → .../PipeDelimitedStyleParameterSerializer.cs
diff --git a/...SpaceDelimitedStyleParameterSerializer.cs → ...SpaceDelimitedStyleParameterSerializer.cs b/...SpaceDelimitedStyleParameterSerializer.cs → ...SpaceDelimitedStyleParameterSerializer.cs
diff --git a/...tions/Functions.OpenAPI/DocumentLoader.cs → ...tions/Functions.OpenApi/DocumentLoader.cs b/...tions/Functions.OpenAPI/DocumentLoader.cs → ...tions/Functions.OpenApi/DocumentLoader.cs
diff --git a/...ons/OpenApiFunctionExecutionParameters.cs → ...ons/OpenApiFunctionExecutionParameters.cs b/...ons/OpenApiFunctionExecutionParameters.cs → ...ons/OpenApiFunctionExecutionParameters.cs
diff --git a/...API/Extensions/OpenApiKernelExtensions.cs → ...Api/Extensions/OpenApiKernelExtensions.cs b/...API/Extensions/OpenApiKernelExtensions.cs → ...Api/Extensions/OpenApiKernelExtensions.cs
diff --git a/...API/Extensions/OpenApiSchemaExtensions.cs → ...Api/Extensions/OpenApiSchemaExtensions.cs b/...API/Extensions/OpenApiSchemaExtensions.cs → ...Api/Extensions/OpenApiSchemaExtensions.cs
diff --git a/.../Extensions/RestApiOperationExtensions.cs → .../Extensions/RestApiOperationExtensions.cs b/.../Extensions/RestApiOperationExtensions.cs → .../Extensions/RestApiOperationExtensions.cs
diff --git a/...ons/RestApiOperationResponseExtensions.cs → ...ons/RestApiOperationResponseExtensions.cs b/...ons/RestApiOperationResponseExtensions.cs → ...ons/RestApiOperationResponseExtensions.cs
diff --git a/...unctions.OpenAPI/Functions.OpenAPI.csproj → ...unctions.OpenApi/Functions.OpenApi.csproj b/...unctions.OpenAPI/Functions.OpenAPI.csproj → ...unctions.OpenApi/Functions.OpenApi.csproj
diff --git a/...s/Functions.OpenAPI/HttpContentFactory.cs → ...s/Functions.OpenApi/HttpContentFactory.cs b/...s/Functions.OpenAPI/HttpContentFactory.cs → ...s/Functions.OpenApi/HttpContentFactory.cs
diff --git a/....OpenAPI/HttpResponseContentSerializer.cs → ....OpenApi/HttpResponseContentSerializer.cs b/....OpenAPI/HttpResponseContentSerializer.cs → ....OpenApi/HttpResponseContentSerializer.cs
diff --git a/...tions/Functions.OpenAPI/JsonPathPlugin.cs → ...tions/Functions.OpenApi/JsonPathPlugin.cs b/...tions/Functions.OpenAPI/JsonPathPlugin.cs → ...tions/Functions.OpenApi/JsonPathPlugin.cs
diff --git a/...nctions.OpenAPI/Model/RestApiOperation.cs → ...nctions.OpenApi/Model/RestApiOperation.cs b/...nctions.OpenAPI/Model/RestApiOperation.cs → ...nctions.OpenApi/Model/RestApiOperation.cs
diff --git a/...Model/RestApiOperationExpectedResponse.cs → ...Model/RestApiOperationExpectedResponse.cs b/...Model/RestApiOperationExpectedResponse.cs → ...Model/RestApiOperationExpectedResponse.cs
diff --git a/...penAPI/Model/RestApiOperationParameter.cs → ...penApi/Model/RestApiOperationParameter.cs b/...penAPI/Model/RestApiOperationParameter.cs → ...penApi/Model/RestApiOperationParameter.cs
diff --git a/...odel/RestApiOperationParameterLocation.cs → ...odel/RestApiOperationParameterLocation.cs b/...odel/RestApiOperationParameterLocation.cs → ...odel/RestApiOperationParameterLocation.cs
diff --git a/...I/Model/RestApiOperationParameterStyle.cs → ...i/Model/RestApiOperationParameterStyle.cs b/...I/Model/RestApiOperationParameterStyle.cs → ...i/Model/RestApiOperationParameterStyle.cs
diff --git a/....OpenAPI/Model/RestApiOperationPayload.cs → ....OpenApi/Model/RestApiOperationPayload.cs b/....OpenAPI/Model/RestApiOperationPayload.cs → ....OpenApi/Model/RestApiOperationPayload.cs
diff --git a/.../Model/RestApiOperationPayloadProperty.cs → .../Model/RestApiOperationPayloadProperty.cs b/.../Model/RestApiOperationPayloadProperty.cs → .../Model/RestApiOperationPayloadProperty.cs
diff --git a/...OpenAPI/Model/RestApiOperationResponse.cs → ...OpenApi/Model/RestApiOperationResponse.cs b/...OpenAPI/Model/RestApiOperationResponse.cs → ...OpenApi/Model/RestApiOperationResponse.cs
diff --git a/...odel/RestApiOperationResponseConverter.cs → ...odel/RestApiOperationResponseConverter.cs b/...odel/RestApiOperationResponseConverter.cs → ...odel/RestApiOperationResponseConverter.cs
diff --git a/...enAPI/Model/RestApiOperationRunOptions.cs → ...enApi/Model/RestApiOperationRunOptions.cs b/...enAPI/Model/RestApiOperationRunOptions.cs → ...enApi/Model/RestApiOperationRunOptions.cs
diff --git a/...PI/OpenAI/KernelOpenAIPluginExtensions.cs → ...pi/OpenAI/KernelOpenAIPluginExtensions.cs b/...PI/OpenAI/KernelOpenAIPluginExtensions.cs → ...pi/OpenAI/KernelOpenAIPluginExtensions.cs
diff --git a/...OpenAIAuthenticateRequestAsyncCallback.cs → ...OpenAIAuthenticateRequestAsyncCallback.cs b/...OpenAIAuthenticateRequestAsyncCallback.cs → ...OpenAIAuthenticateRequestAsyncCallback.cs
diff --git a/...nAPI/OpenAI/OpenAIAuthenticationConfig.cs → ...nApi/OpenAI/OpenAIAuthenticationConfig.cs b/...nAPI/OpenAI/OpenAIAuthenticationConfig.cs → ...nApi/OpenAI/OpenAIAuthenticationConfig.cs
diff --git a/...enAI/OpenAIFunctionExecutionParameters.cs → ...enAI/OpenAIFunctionExecutionParameters.cs b/...enAI/OpenAIFunctionExecutionParameters.cs → ...enAI/OpenAIFunctionExecutionParameters.cs
diff --git a/...OpenAPI/OpenApi/IOpenApiDocumentParser.cs → ...OpenApi/OpenApi/IOpenApiDocumentParser.cs b/...OpenAPI/OpenApi/IOpenApiDocumentParser.cs → ...OpenApi/OpenApi/IOpenApiDocumentParser.cs
diff --git a/....OpenAPI/OpenApi/OpenApiDocumentParser.cs → ....OpenApi/OpenApi/OpenApiDocumentParser.cs b/....OpenAPI/OpenApi/OpenApiDocumentParser.cs → ....OpenApi/OpenApi/OpenApiDocumentParser.cs
diff --git a/...nctions.OpenAPI/RestApiOperationRunner.cs → ...nctions.OpenApi/RestApiOperationRunner.cs b/...nctions.OpenAPI/RestApiOperationRunner.cs → ...nctions.OpenApi/RestApiOperationRunner.cs
diff --git a/dotnet/src/Functions/Functions.UnitTests/Functions.UnitTests.csproj b/dotnet/src/Functions/Functions.UnitTests/Functions.UnitTests.csproj
@@ -56,7 +56,7 @@
     <ProjectReference Include="..\..\SemanticKernel.Core\SemanticKernel.Core.csproj" />
     <ProjectReference Include="..\Functions.Grpc\Functions.Grpc.csproj" />
     <ProjectReference Include="..\Functions.Markdown\Functions.Markdown.csproj" />
-    <ProjectReference Include="..\Functions.OpenAPI\Functions.OpenAPI.csproj" />
+    <ProjectReference Include="..\Functions.OpenApi\Functions.OpenApi.csproj" />
     <ProjectReference Include="..\Functions.Yaml\Functions.Yaml.csproj" />
   </ItemGroup>
 </Project>
diff --git a/dotnet/src/IntegrationTests/IntegrationTests.csproj b/dotnet/src/IntegrationTests/IntegrationTests.csproj
@@ -58,7 +58,7 @@
     <ProjectReference Include="..\Planners\Planners.OpenAI\Planners.OpenAI.csproj" />
     <ProjectReference Include="..\Plugins\Plugins.Core\Plugins.Core.csproj" />
     <ProjectReference Include="..\Plugins\Plugins.Memory\Plugins.Memory.csproj" />
-    <ProjectReference Include="..\Functions\Functions.OpenAPI\Functions.OpenAPI.csproj" />
+    <ProjectReference Include="..\Functions\Functions.OpenApi\Functions.OpenApi.csproj" />
     <ProjectReference Include="..\Plugins\Plugins.Web\Plugins.Web.csproj" />
     <ProjectReference Include="..\SemanticKernel.Core\SemanticKernel.Core.csproj" />
   </ItemGroup>

diff --git a/dotnet/src/IntegrationTests/Planners/StepwisePlanner/StepwisePlannerTests.cs b/dotnet/src/IntegrationTests/Planners/StepwisePlanner/StepwisePlannerTests.cs
@@ -4,7 +4,7 @@
 using System.Threading.Tasks;
 using Microsoft.Extensions.Configuration;
 using Microsoft.SemanticKernel;
-using Microsoft.SemanticKernel.Plugins.OpenAPI.OpenAI;
+using Microsoft.SemanticKernel.Plugins.OpenApi.OpenAI;
 using Microsoft.SemanticKernel.Planning;
 using Microsoft.SemanticKernel.Plugins.Core;
 using Microsoft.SemanticKernel.Plugins.Web;

diff --git a/dotnet/src/Planners/Planners.OpenAI/Planners.OpenAI.csproj b/dotnet/src/Planners/Planners.OpenAI/Planners.OpenAI.csproj
@@ -32,7 +32,7 @@
 
   <ItemGroup>
     <ProjectReference Include="..\..\Connectors\Connectors.OpenAI\Connectors.OpenAI.csproj" />
-    <ProjectReference Include="..\..\Functions\Functions.OpenAPI\Functions.OpenAPI.csproj" />
+    <ProjectReference Include="..\..\Functions\Functions.OpenApi\Functions.OpenApi.csproj" />
     <ProjectReference Include="..\..\Functions\Functions.Yaml\Functions.Yaml.csproj" />
     <ProjectReference Include="..\..\SemanticKernel.Abstractions\SemanticKernel.Abstractions.csproj" />
     <ProjectReference Include="..\..\SemanticKernel.Core\SemanticKernel.Core.csproj" />

diff --git a/python/samples/kernel-syntax-examples/openapi_example/README.md b/python/samples/kernel-syntax-examples/openapi_example/README.md
@@ -1,9 +1,9 @@
-### Running the OpenApi syntax example
+### Running the OpenAPI syntax example
 
 1. In a terminal, navigate to `semantic_kernel/python/samples/kernel-syntax-examples/openapi_example`.
 
 2. Run `poetry install` followed by `poetry shell` to enter poetry's virtual environment.
 
 3. Start the server by running `python openapi_server.py`.
 
-4. In another terminal, do steps 1 & 2.  Then, run `python openapi_client.py`, which will register a skill representing the API defined in openapi.yaml
+4. In another terminal, do steps 1 & 2. Then, run `python openapi_client.py`, which will register a skill representing the API defined in openapi.yaml