Merge pull request #499 from solliancenet/jdh-sessionless-core

OpenAPI documentation fixes and refreshed CoreAPI Postman collection
solliancenet · Jan 27, 2024 · 2199bb6 · 2199bb6
2 parents 4dfedcf + 96fd35f
commit 2199bb6
Show file tree

Hide file tree

Showing 11 changed files with 23 additions and 13 deletions.
diff --git a/docs/FoundationaLLM.Core.API.postman_collection.json b/docs/FoundationaLLM.Core.API.postman_collection.json
@@ -1,6 +1,6 @@
 {
 	"info": {
-		"_postman_id": "d1ed4d97-5dc8-4e63-8e02-4b17dff3401c",
+		"_postman_id": "9ad62116-3057-4166-abfc-ece23923bff5",
 		"name": "FoundationaLLM.Core.API",
 		"description": "FoundationaLLM.Core.API\n\nContact Support:\n Name: Solliance, Inc.\n Email: [email protected]",
 		"schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json",
@@ -89,7 +89,7 @@
 								],
 								"body": {
 									"mode": "raw",
-									"raw": "<string>",
+									"raw": "{\n  \"user_prompt\": \"<string>\"\n}",
 									"options": {
 										"raw": {
 											"headerFamily": "json",
@@ -128,7 +128,7 @@
 										],
 										"body": {
 											"mode": "raw",
-											"raw": "<string>",
+											"raw": "{\n  \"user_prompt\": \"<string>\"\n}",
 											"options": {
 												"raw": {
 													"headerFamily": "json",
@@ -584,7 +584,7 @@
 												}
 											],
 											"cookie": [],
-											"body": "{\n  \"id\": \"<string>\",\n  \"type\": \"<string>\",\n  \"sessionId\": \"<string>\",\n  \"tokensUsed\": \"<integer>\",\n  \"name\": \"<string>\",\n  \"upn\": \"<string>\",\n  \"deleted\": \"<boolean>\",\n  \"messages\": [\n    {\n      \"id\": \"<string>\",\n      \"type\": \"<string>\",\n      \"sessionId\": \"<string>\",\n      \"timeStamp\": \"<dateTime>\",\n      \"sender\": \"<string>\",\n      \"senderDisplayName\": \"<string>\",\n      \"tokens\": \"<integer>\",\n      \"text\": \"<string>\",\n      \"rating\": \"<boolean>\",\n      \"upn\": \"<string>\",\n      \"deleted\": \"<boolean>\",\n      \"vector\": [\n        \"<float>\",\n        \"<float>\"\n      ],\n      \"completionPromptId\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"type\": \"<string>\",\n      \"sessionId\": \"<string>\",\n      \"timeStamp\": \"<dateTime>\",\n      \"sender\": \"<string>\",\n      \"senderDisplayName\": \"<string>\",\n      \"tokens\": \"<integer>\",\n      \"text\": \"<string>\",\n      \"rating\": \"<boolean>\",\n      \"upn\": \"<string>\",\n      \"deleted\": \"<boolean>\",\n      \"vector\": [\n        \"<float>\",\n        \"<float>\"\n      ],\n      \"completionPromptId\": \"<string>\"\n    }\n  ]\n}"
+											"body": "{\n  \"id\": \"<string>\",\n  \"type\": \"<string>\",\n  \"sessionId\": \"<string>\",\n  \"tokensUsed\": \"<integer>\",\n  \"name\": \"<string>\",\n  \"upn\": \"<string>\",\n  \"deleted\": \"<boolean>\"\n}"
 										}
 									]
 								}
@@ -966,7 +966,7 @@
 								}
 							],
 							"cookie": [],
-							"body": "[\n  {\n    \"id\": \"<string>\",\n    \"type\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"tokensUsed\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"upn\": \"<string>\",\n    \"deleted\": \"<boolean>\",\n    \"messages\": [\n      {\n        \"id\": \"<string>\",\n        \"type\": \"<string>\",\n        \"sessionId\": \"<string>\",\n        \"timeStamp\": \"<dateTime>\",\n        \"sender\": \"<string>\",\n        \"senderDisplayName\": \"<string>\",\n        \"tokens\": \"<integer>\",\n        \"text\": \"<string>\",\n        \"rating\": \"<boolean>\",\n        \"upn\": \"<string>\",\n        \"deleted\": \"<boolean>\",\n        \"vector\": [\n          \"<float>\",\n          \"<float>\"\n        ],\n        \"completionPromptId\": \"<string>\"\n      },\n      {\n        \"id\": \"<string>\",\n        \"type\": \"<string>\",\n        \"sessionId\": \"<string>\",\n        \"timeStamp\": \"<dateTime>\",\n        \"sender\": \"<string>\",\n        \"senderDisplayName\": \"<string>\",\n        \"tokens\": \"<integer>\",\n        \"text\": \"<string>\",\n        \"rating\": \"<boolean>\",\n        \"upn\": \"<string>\",\n        \"deleted\": \"<boolean>\",\n        \"vector\": [\n          \"<float>\",\n          \"<float>\"\n        ],\n        \"completionPromptId\": \"<string>\"\n      }\n    ]\n  },\n  {\n    \"id\": \"<string>\",\n    \"type\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"tokensUsed\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"upn\": \"<string>\",\n    \"deleted\": \"<boolean>\",\n    \"messages\": [\n      {\n        \"id\": \"<string>\",\n        \"type\": \"<string>\",\n        \"sessionId\": \"<string>\",\n        \"timeStamp\": \"<dateTime>\",\n        \"sender\": \"<string>\",\n        \"senderDisplayName\": \"<string>\",\n        \"tokens\": \"<integer>\",\n        \"text\": \"<string>\",\n        \"rating\": \"<boolean>\",\n        \"upn\": \"<string>\",\n        \"deleted\": \"<boolean>\",\n        \"vector\": [\n          \"<float>\",\n          \"<float>\"\n        ],\n        \"completionPromptId\": \"<string>\"\n      },\n      {\n        \"id\": \"<string>\",\n        \"type\": \"<string>\",\n        \"sessionId\": \"<string>\",\n        \"timeStamp\": \"<dateTime>\",\n        \"sender\": \"<string>\",\n        \"senderDisplayName\": \"<string>\",\n        \"tokens\": \"<integer>\",\n        \"text\": \"<string>\",\n        \"rating\": \"<boolean>\",\n        \"upn\": \"<string>\",\n        \"deleted\": \"<boolean>\",\n        \"vector\": [\n          \"<float>\",\n          \"<float>\"\n        ],\n        \"completionPromptId\": \"<string>\"\n      }\n    ]\n  }\n]"
+							"body": "[\n  {\n    \"id\": \"<string>\",\n    \"type\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"tokensUsed\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"upn\": \"<string>\",\n    \"deleted\": \"<boolean>\"\n  },\n  {\n    \"id\": \"<string>\",\n    \"type\": \"<string>\",\n    \"sessionId\": \"<string>\",\n    \"tokensUsed\": \"<integer>\",\n    \"name\": \"<string>\",\n    \"upn\": \"<string>\",\n    \"deleted\": \"<boolean>\"\n  }\n]"
 						}
 					]
 				},
@@ -1035,7 +1035,7 @@
 								}
 							],
 							"cookie": [],
-							"body": "{\n  \"id\": \"<string>\",\n  \"type\": \"<string>\",\n  \"sessionId\": \"<string>\",\n  \"tokensUsed\": \"<integer>\",\n  \"name\": \"<string>\",\n  \"upn\": \"<string>\",\n  \"deleted\": \"<boolean>\",\n  \"messages\": [\n    {\n      \"id\": \"<string>\",\n      \"type\": \"<string>\",\n      \"sessionId\": \"<string>\",\n      \"timeStamp\": \"<dateTime>\",\n      \"sender\": \"<string>\",\n      \"senderDisplayName\": \"<string>\",\n      \"tokens\": \"<integer>\",\n      \"text\": \"<string>\",\n      \"rating\": \"<boolean>\",\n      \"upn\": \"<string>\",\n      \"deleted\": \"<boolean>\",\n      \"vector\": [\n        \"<float>\",\n        \"<float>\"\n      ],\n      \"completionPromptId\": \"<string>\"\n    },\n    {\n      \"id\": \"<string>\",\n      \"type\": \"<string>\",\n      \"sessionId\": \"<string>\",\n      \"timeStamp\": \"<dateTime>\",\n      \"sender\": \"<string>\",\n      \"senderDisplayName\": \"<string>\",\n      \"tokens\": \"<integer>\",\n      \"text\": \"<string>\",\n      \"rating\": \"<boolean>\",\n      \"upn\": \"<string>\",\n      \"deleted\": \"<boolean>\",\n      \"vector\": [\n        \"<float>\",\n        \"<float>\"\n      ],\n      \"completionPromptId\": \"<string>\"\n    }\n  ]\n}"
+							"body": "{\n  \"id\": \"<string>\",\n  \"type\": \"<string>\",\n  \"sessionId\": \"<string>\",\n  \"tokensUsed\": \"<integer>\",\n  \"name\": \"<string>\",\n  \"upn\": \"<string>\",\n  \"deleted\": \"<boolean>\"\n}"
 						}
 					]
 				}

diff --git a/src/dotnet/AgentFactoryAPI/AgentFactoryAPI.csproj b/src/dotnet/AgentFactoryAPI/AgentFactoryAPI.csproj
@@ -21,7 +21,8 @@
 	  <PackageReference Include="Microsoft.Azure.AppConfiguration.AspNetCore" Version="7.0.0" />
 	  <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.0.0" />
 	  <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.19.5" />
-	  <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Newtonsoft" Version="6.5.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/dotnet/AgentFactoryAPI/Program.cs b/src/dotnet/AgentFactoryAPI/Program.cs
@@ -144,7 +144,8 @@ public static void Main(string[] args)
 
                     // Adds auth via X-API-KEY header
                     options.AddAPIKeyAuth();
-                });
+                })
+                .AddSwaggerGenNewtonsoftSupport();
 
             builder.Services.Configure<RouteOptions>(options =>
             {

diff --git a/src/dotnet/GatekeeperAPI/GatekeeperAPI.csproj b/src/dotnet/GatekeeperAPI/GatekeeperAPI.csproj
@@ -30,7 +30,8 @@
 	  <PackageReference Include="Microsoft.Azure.AppConfiguration.AspNetCore" Version="7.0.0" />
 	  <PackageReference Include="Microsoft.Extensions.Http.Resilience" Version="8.0.0" />
 	  <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.19.5" />
-	  <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Newtonsoft" Version="6.5.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/dotnet/GatekeeperAPI/Program.cs b/src/dotnet/GatekeeperAPI/Program.cs
@@ -130,7 +130,8 @@ public static void Main(string[] args)
 
                     // Adds auth via X-API-KEY header
                     options.AddAPIKeyAuth();
-                });
+                })
+                .AddSwaggerGenNewtonsoftSupport();
 
             builder.Services.Configure<RouteOptions>(options =>
             {

diff --git a/src/dotnet/ManagementAPI/ManagementAPI.csproj b/src/dotnet/ManagementAPI/ManagementAPI.csproj
@@ -25,6 +25,7 @@
   <ItemGroup>
     <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.19.5" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Newtonsoft" Version="6.5.0" />
     <PackageReference Include="Asp.Versioning.Http" Version="8.0.0" />
     <PackageReference Include="Asp.Versioning.Mvc.ApiExplorer" Version="8.0.0" />
     <PackageReference Include="Microsoft.ApplicationInsights.AspNetCore" Version="2.22.0" />

diff --git a/src/dotnet/ManagementAPI/Program.cs b/src/dotnet/ManagementAPI/Program.cs
@@ -134,7 +134,8 @@ public static void Main(string[] args)
 
                     // Integrate xml comments
                     options.IncludeXmlComments(filePath);
-                });
+                })
+                .AddSwaggerGenNewtonsoftSupport();
 
             builder.Services.Configure<RouteOptions>(options =>
             {

diff --git a/src/dotnet/SemanticKernelAPI/Program.cs b/src/dotnet/SemanticKernelAPI/Program.cs
@@ -73,7 +73,8 @@ public static void Main(string[] args)
 
                     // Adds auth via X-API-KEY header
                     options.AddAPIKeyAuth();
-                });
+                })
+                .AddSwaggerGenNewtonsoftSupport();
 
             builder.Services.AddOptions<SemanticKernelServiceSettings>()
                 .Bind(builder.Configuration.GetSection(AppConfigurationKeySections.FoundationaLLM_SemanticKernelAPI));

diff --git a/src/dotnet/SemanticKernelAPI/SemanticKernelAPI.csproj b/src/dotnet/SemanticKernelAPI/SemanticKernelAPI.csproj
@@ -18,6 +18,7 @@
     <PackageReference Include="Microsoft.Azure.AppConfiguration.AspNetCore" Version="7.0.0" />
     <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.19.5" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Newtonsoft" Version="6.5.0" />
   </ItemGroup>
 
   <ItemGroup>

diff --git a/src/dotnet/VectorizationAPI/Program.cs b/src/dotnet/VectorizationAPI/Program.cs
@@ -103,7 +103,8 @@
 
         // Integrate xml comments
         options.IncludeXmlComments(filePath);
-    });
+    })
+    .AddSwaggerGenNewtonsoftSupport();
 
 builder.Services.Configure<RouteOptions>(options =>
 {

diff --git a/src/dotnet/VectorizationAPI/VectorizationAPI.csproj b/src/dotnet/VectorizationAPI/VectorizationAPI.csproj
@@ -19,6 +19,7 @@
     <PackageReference Include="Microsoft.Azure.AppConfiguration.AspNetCore" Version="7.0.0" />
     <PackageReference Include="Microsoft.VisualStudio.Azure.Containers.Tools.Targets" Version="1.19.5" />
     <PackageReference Include="Swashbuckle.AspNetCore" Version="6.5.0" />
+    <PackageReference Include="Swashbuckle.AspNetCore.Newtonsoft" Version="6.5.0" />
   </ItemGroup>
 
   <ItemGroup>