Changeset 460 for TFP-WebServer/WebServer/src/WebAPI/APIs

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

Location:

TFP-WebServer/WebServer/src/WebAPI/APIs

Files:

• Command.openapi.yaml (added)
• GameData/Item.openapi.yaml (added)
• GameData/Mods.openapi.yaml (added)
• Log.openapi.yaml (added)
• OpenAPI.openapi.yaml (modified) (4 diffs)
• Permissions/Blacklist.cs (modified) (1 diff)
• Permissions/Blacklist.openapi.yaml (added)
• WorldState/Animal.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

TFP-WebServer/WebServer/src/WebAPI/APIs/Permissions/Blacklist.cs

@@ -100 +100 @@
                         }
 
-                        bool validId = PlatformUserIdentifierAbs.TryFromCombinedString (id, out _userId);
-                        if (!validId) {
+                        if (PlatformUserIdentifierAbs.TryFromCombinedString (id, out _userId)) {
                                 SendEmptyResponse (_context, HttpStatusCode.BadRequest, _jsonInputData, "INVALID_USER");
+                                return false;
                         }
 
-                        return validId;
+                        return true;
                 }
 

TFP-WebServer/WebServer/src/WebAPI/APIs/WorldState/Animal.openapi.yaml

@@ -2 +2 @@
 info:
   title: Animal
-  version: 1
+  version: '1'
 
 components:
@@ -10 +10 @@
       properties:
         id:
-          $ref: '#/components/schemas/TypeEntityId'
+          $ref: './openapi.yaml#/components/schemas/TypeEntityId'
         name:
           type: string
@@ -16 +16 @@
             - animalStag
         position:
-          $ref: '#/components/schemas/TypeVector3i'
+          $ref: './openapi.yaml#/components/schemas/TypeVector3i'
       required:
         - id
@@ -47 +47 @@
                     $ref: '#/components/schemas/AnimalList'
                   meta:
-                    $ref: '#/components/schemas/ResultEnvelopeMeta'
+                    $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
                 required:
                   - data
                   - meta
         403:
-          $ref: '#/components/responses/Unauthorized'
+          $ref: './openapi.yaml#/components/responses/Unauthorized'
       security:
         - apiTokenName: []