Changeset 460 for TFP-WebServer/MarkersMod/src/Markers.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/MarkersMod/src/Markers.openapi.yaml (modified) (9 diffs)

TFP-WebServer/MarkersMod/src/Markers.openapi.yaml

@@ -2 +2 @@
 info:
   title: Markers
-  version: 1
+  version: '1'
 
 components:
@@ -80 +80 @@
                 $ref: '#/components/schemas/MarkersList'
               meta:
-                $ref: '#/components/schemas/ResultEnvelopeMeta'
+                $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
             required:
               - data
@@ -96 +96 @@
                 format: uuid
               meta:
-                $ref: '#/components/schemas/ResultEnvelopeMeta'
+                $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
             required:
               - data
@@ -110 +110 @@
         type: string
         format: uuid
+      description: ID of marker to fetch
 
 
@@ -118 +119 @@
         - Map
       summary: Markers list
-      description: Fetch a list of the all defined map markers
+      description: Fetch a list of all defined map markers
       operationId: markers.get
       responses:
@@ -141 +142 @@
             Invalid request body, errorCode will be one of 'NO_OR_INVALID_X',
             'NO_OR_INVALID_Y'
-          $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
+          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
         403:
-          $ref: '#/components/responses/Unauthorized'
+          $ref: './openapi.yaml#/components/responses/Unauthorized'
       security:
         - apiTokenName: []
@@ -164 +165 @@
         404:
           description: Marker ID not found, errorCode will be 'ID_NOT_FOUND'
-          $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
+          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
 
     put:
@@ -184 +185 @@
             Invalid request body, errorCode will be one of 'NO_OR_INVALID_X',
             'NO_OR_INVALID_Y'
-          $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
+          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
         404:
           description: Marker ID not found, errorCode will be 'ID_NOT_FOUND'
-          $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
+          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
         403:
-          $ref: '#/components/responses/Unauthorized'
+          $ref: './openapi.yaml#/components/responses/Unauthorized'
       security:
         - apiTokenName: []
@@ -206 +207 @@
         204:
           description: Deleted marker
-          $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
+          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
         404:
           description: Marker ID not found
-          $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
+          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
         403:
-          $ref: '#/components/responses/Unauthorized'
+          $ref: './openapi.yaml#/components/responses/Unauthorized'
       security:
         - apiTokenName: []