Ignore:
Timestamp:
Aug 11, 2023, 6:29:09 PM (16 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/MarkersMod
Files:
1 added
1 edited

Legend:

Unmodified
Added
Removed
  • TFP-WebServer/MarkersMod/src/Markers.openapi.yaml

    r459 r460  
    22info:
    33  title: Markers
    4   version: 1
     4  version: '1'
    55
    66components:
     
    8080                $ref: '#/components/schemas/MarkersList'
    8181              meta:
    82                 $ref: '#/components/schemas/ResultEnvelopeMeta'
     82                $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
    8383            required:
    8484              - data
     
    9696                format: uuid
    9797              meta:
    98                 $ref: '#/components/schemas/ResultEnvelopeMeta'
     98                $ref: './openapi.yaml#/components/schemas/ResultEnvelopeMeta'
    9999            required:
    100100              - data
     
    110110        type: string
    111111        format: uuid
     112      description: ID of marker to fetch
    112113
    113114
     
    118119        - Map
    119120      summary: Markers list
    120       description: Fetch a list of the all defined map markers
     121      description: Fetch a list of all defined map markers
    121122      operationId: markers.get
    122123      responses:
     
    141142            Invalid request body, errorCode will be one of 'NO_OR_INVALID_X',
    142143            'NO_OR_INVALID_Y'
    143           $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
     144          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
    144145        403:
    145           $ref: '#/components/responses/Unauthorized'
     146          $ref: './openapi.yaml#/components/responses/Unauthorized'
    146147      security:
    147148        - apiTokenName: []
     
    164165        404:
    165166          description: Marker ID not found, errorCode will be 'ID_NOT_FOUND'
    166           $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
     167          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
    167168
    168169    put:
     
    184185            Invalid request body, errorCode will be one of 'NO_OR_INVALID_X',
    185186            'NO_OR_INVALID_Y'
    186           $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
     187          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
    187188        404:
    188189          description: Marker ID not found, errorCode will be 'ID_NOT_FOUND'
    189           $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
     190          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
    190191        403:
    191           $ref: '#/components/responses/Unauthorized'
     192          $ref: './openapi.yaml#/components/responses/Unauthorized'
    192193      security:
    193194        - apiTokenName: []
     
    206207        204:
    207208          description: Deleted marker
    208           $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
     209          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
    209210        404:
    210211          description: Marker ID not found
    211           $ref: '#/components/responses/HttpEmptyEnvelopedResponse'
     212          $ref: './openapi.yaml#/components/responses/HttpEmptyEnvelopedResponse'
    212213        403:
    213           $ref: '#/components/responses/Unauthorized'
     214          $ref: './openapi.yaml#/components/responses/Unauthorized'
    214215      security:
    215216        - apiTokenName: []
Note: See TracChangeset for help on using the changeset viewer.