Commit 74618fa5 authored by Jerome Royan's avatar Jerome Royan
Browse files

fix: all responses are json formatted to avoid conflicts with some generators

parent c8b699bf

API/common/commonopenapi.yaml

+16 −0
Original line number Diff line number Diff line
@@ -153,6 +153,22 @@ 
              schema:

                $ref: '#/components/schemas/Error'

              example: "Success request"



        200_UuidResponse:

          description: OK, return the UUID of the Trackable defined by the world storage.

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/Error'

              example: "777266da-e286-11ec-8fea-0242ac120002"



        201_NullResponse: 

          description: Null response.

          content:

            application/json:

              schema:

                $ref: '#/components/schemas/Error'

              example: "string"

        #####################

        # 3xx : Redirection #

        #####################

API/worldstorage/worldstorageopenapi.yaml

+28 −93
Original line number Diff line number Diff line
@@ -170,19 +170,9 @@ paths: 
                $ref: '#/components/schemas/Trackable'

      responses:

        '200':

          description: OK, return the UUID of the Trackable defined by the world storage.

          content:

            text/plain:

              schema:

                type: string

                example: "777266da-e286-11ec-8fea-0242ac120002"

          $ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'

        '201':

          description: Null response.

          content:

            text/plain:

              schema:

                type: string

                example: ""

            $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'

        '409':
@@ -209,12 +199,7 @@ paths: 
                $ref: '#/components/schemas/Trackable'

      responses:

        '200':

          description: OK, return the UUID of the modified Trackable.

          content:

            text/plain:

              schema:

                type: string

                example: "777266da-e286-11ec-8fea-0242ac120002"

          $ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'

        '404':
@@ -242,12 +227,7 @@ paths: 
                items :

                  $ref: "#/components/schemas/Trackable"          

        '201':

          description: Null response.

          content:

            text/plain:

              schema:

                type: string

                example: ""

          $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'

        default:

          $ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError'
@@ -277,6 +257,8 @@ paths: 
            application/json:

              schema:

                $ref: '#/components/schemas/Trackable'

        '201':

          $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse' 

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'

        '404':
@@ -301,12 +283,7 @@ paths: 
            format: uuid

      responses:

        '200':

          description: OK, delete successful.

          content:

            text/plain:

              schema:

                type: string

                example: "Element succesfully deleted"

          $ref: '../common/commonopenapi.yaml#/components/schemas/200_SuccessRequest'

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'

        '404':
@@ -336,19 +313,9 @@ paths: 
                $ref: '#/components/schemas/WorldAnchor'

      responses:

        '200':

          description: OK, return the UUID of the World Anchor defined by the world storage.

          content:

            text/plain:

              schema:

                type: string    

                example: "777266da-e286-11ec-8fea-0242ac120002"

          $ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'

        '201':

          description: Null response.

          content:

            text/plain:

              schema:

                type: string

                example: ""

          $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'

        '409':
@@ -375,12 +342,9 @@ paths: 
                $ref: '#/components/schemas/WorldAnchor'

      responses:

        '200':

          description: OK, return the UUID of the modified World Anchor.

          content:

            text/plain:

              schema:

                type: string

                example: "777266da-e286-11ec-8fea-0242ac120002"

          $ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'

        '201':

          $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'

        '404':
@@ -408,12 +372,7 @@ paths: 
                items :

                  $ref: "#/components/schemas/WorldAnchor"          

        '201':

          description: Null response.

          content:

            text/plain:

              schema:

                type: string

                example: ""

          $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'

        default:

          $ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError'
@@ -443,6 +402,8 @@ paths: 
            application/json:

              schema:

                $ref: '#/components/schemas/WorldAnchor' 

        '201':

          $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'

        '404':
@@ -467,12 +428,7 @@ paths: 
            format: uuid

      responses:

        '200':

          description: OK, delete successful.

          content:

            text/plain:

              schema:

                type: string

                example: "Element succesfuly deleted"

          $ref: '../common/commonopenapi.yaml#/components/schemas/200_SuccessRequest'

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'

        '404':
@@ -502,19 +458,9 @@ paths: 
                $ref: '#/components/schemas/WorldLink'                

      responses:

        '200':

          description: OK, return the UUID of the World Link defined by the world storage.

          content:

            text/plain:

              schema: 

                type: string

                example: "777266da-e286-11ec-8fea-0242ac120002"            

          $ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'            

        '201':

          description: Null response.

          content:

            text/plain:

              schema:

                type: string

                example: ""

          $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'

        '409':
@@ -541,12 +487,9 @@ paths: 
                $ref: '#/components/schemas/WorldLink'

      responses:

        '200':

          description: OK, return the UUID of the modified World Link.

          content:

            text/plain:

              schema:

                type: string

                example: "777266da-e286-11ec-8fea-0242ac120002"

          $ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'

        '201':

          $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'

        '404':
@@ -574,12 +517,7 @@ paths: 
                items :

                  $ref: "#/components/schemas/WorldLink"          

        '201':

          description: Null response.

          content:

            text/plain:

              schema:

                type: string

                example: ""

          $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'

        default:

          $ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError'
@@ -609,6 +547,8 @@ paths: 
            application/json:

              schema:

                $ref: '#/components/schemas/WorldLink'

        '201':

          $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'

        '404':
@@ -633,12 +573,7 @@ paths: 
            format: uuid

      responses:

        '200':

          description: OK, delete successful.

          content:

            text/plain:

              schema:

                type: string

                example: "Element succesfully deleted"

          $ref: '../common/commonopenapi.yaml#/components/schemas/200_SuccessRequest'

        '400':

          $ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'

        '404':