Changeset 460 for TFP-WebServer/WebServer/src/WebAPI/APIs/OpenAPI.openapi.yaml

Timestamp:

Aug 11, 2023, 6:29:09 PM (15 months ago)

Author:

alloc

Message:

More OpenAPI specs added
OpenAPI specs cleanup to have everything validate fine
Added CORS support to API endpoints

File:

• TFP-WebServer/WebServer/src/WebAPI/APIs/OpenAPI.openapi.yaml (modified) (4 diffs)

TFP-WebServer/WebServer/src/WebAPI/APIs/OpenAPI.openapi.yaml

@@ -2 +2 @@
 info:
   title: OpenAPI
-  version: 1
+  version: '1'
 
 
@@ -8 +8 @@
   /api/OpenAPI/openapi.yaml:
     get:
+      tags:
+        - Meta
+      summary: OpenAPI master document
+      description: Fetch the OpenAPI master document, referencing all the individual WebAPI specs
       operationId: OpenAPI.openapi
       responses:
@@ -14 +18 @@
             application/json: {}
           description: OpenAPI master document
+  /api/OpenAPI/{name}.openapi.yaml:
+    get:
       tags:
         - Meta
-  /api/OpenAPI/{name}.openapi.yaml:
-    get:
+      summary: OpenAPI spec for single API
+      description: Fetch the OpenAPI spec of a single WebAPI
       operationId: OpenAPI.getAPI
       parameters:
@@ -35 +41 @@
             application/json: {}
           description: No OpenAPI spec found for the API name
-      tags:
-        - Meta