Changeset 460 for TFP-WebServer/WebServer/src/WebAPI/OpenAPI.master.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/OpenAPI.master.yaml (modified) (3 diffs)

TFP-WebServer/WebServer/src/WebAPI/OpenAPI.master.yaml

@@ +1 @@
+openapi: 3.1.0
 info:
   title: 7 Days To Die WebAPI
-  version: 1.0.0
-openapi: 3.1.0
+  version: '1.0.0'
 servers:
   - url: /
@@ -81 +81 @@
       description: 3D vector in full blocks
 
+    TypeUserIdString:
+      type: string
+      pattern: '^\[a-zA-Z]+_[\w]+$'
+      examples:
+        - 'Steam_76561198021925107'
+      description: User ID including platform
+
+    TypeUserIdObject:
+      anyOf:
+        - type: object
+          properties:
+            combinedString:
+              $ref: '#/components/schemas/TypeUserIdString'
+            platformId:
+              type: string
+              examples:
+                - Steam
+                - XBL
+              description: Gaming platform the ID references
+            userId:
+              type: string
+              examples:
+                - '76561198021925107'
+              description: Unique ID of the user within the given gaming platform
+          required:
+            - combinedString
+            - platformId
+            - userId
+          description: User ID
+        - type: 'null'
+
 
   responses:
@@ -126 +157 @@
 
 paths:
-  allOf: