Commit b01d54c0 authored by Jerome Royan's avatar Jerome Royan
Browse files

Merge branch 'fix/RestBed_Generation' of...

Merge branch 'fix/RestBed_Generation' of https://forge.etsi.org/rep/arf/openapi into fix/RestBed_Generation
parents 8a76dd39 c0f766ef
Loading
Loading
Loading
Loading
+17 −13
Original line number Diff line number Diff line
@@ -13,18 +13,6 @@
    #-------------------------------
    schemas:
          
      Mode_WorldAnalysis:
        description: Mode representing the context of the relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
        type: string
        enum: [TRACKABLES_TO_DEVICE, DEVICE_TO_TRACKABLES]
        example: TRACKABLES_TO_DEVICE
      
      Mode_WorldStorage:
        description: Mode representing the context of the relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
        type: string
        enum: [TRACKABLES_TO_REQUEST, REQUEST_TO_TRACKABLES]
        example: TRACKABLES_TO_REQUEST
      
      EncodingInformationStructure:
        description: An object holding the info of a Trackable`'`s encoding information `:` the data format and the version.
        required:
@@ -165,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 #
        #####################
+14 −8
Original line number Diff line number Diff line
@@ -115,8 +115,8 @@ paths:
        in: query
        description: Mode representing the context of the Relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
        required: true
        ## issue with some generator when a query reference a schemas with enums 
        ## Suppress reference to '../common/commonopenapi.yaml#/components/schemas/Mode_WorldAnalysis'.
        ## issue with some generator when a query reference a schema with enums 
        ## Suppress reference to '#/components/schemas/Mode_WorldAnalysis'.
        schema:
          description: Mode representing the context of the relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
          type: string
@@ -173,7 +173,7 @@ paths:
                example: "fa8bbe40-8052-11ec-a8a3-0242ac120002"
              mode:
                description: Mode representing the context of the Relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
                $ref: '../common/commonopenapi.yaml#/components/schemas/Mode_WorldAnalysis'
                $ref: '#/components/schemas/Mode_WorldAnalysis'
            required:
              - uuid
              - mode
@@ -313,7 +313,7 @@ paths:
                properties:
                  mode:
                    description: Mode representing the context of the Relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
                    $ref: '../common/commonopenapi.yaml#/components/schemas/Mode_WorldAnalysis'
                    $ref: '#/components/schemas/Mode_WorldAnalysis'
                  validity: 
                    description: Subscription validity delay in millisecond 
                    type: integer
@@ -453,6 +453,12 @@ components:
  #-------------------------------
  schemas:
    
    Mode_WorldAnalysis:
        description: Mode representing the context of the relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
        type: string
        enum: [TRACKABLES_TO_DEVICE, DEVICE_TO_TRACKABLES]
        example: TRACKABLES_TO_DEVICE

    Pose:
      description: An element representing the result of the pose estimation of an AR device, a Trackable or a WorldAnchor by the World Analysis
      type: object
@@ -481,7 +487,7 @@ components:
          example : 50.00
        mode:
          description: Mode representing the context of the Relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
          $ref: '../common/commonopenapi.yaml#/components/schemas/Mode_WorldAnalysis'
          $ref: '#/components/schemas/Mode_WorldAnalysis'
        value:
          description: The pose value
          oneOf:
@@ -590,7 +596,7 @@ components:
          example: "fa8bbe40-8052-11ec-a8a3-0242ac120002"
        mode:
          description: Mode representing the context of the Relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
          $ref: '../common/commonopenapi.yaml#/components/schemas/Mode_WorldAnalysis'
          $ref: '#/components/schemas/Mode_WorldAnalysis'
        validity: 
          description: Subscription validity delay in millisecond 
          type: integer
@@ -619,7 +625,7 @@ components:
          description: List of modes representing the context of the Relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
          type: array
          items:
            $ref: '../common/commonopenapi.yaml#/components/schemas/Mode_WorldAnalysis'
            $ref: '#/components/schemas/Mode_WorldAnalysis'
        validity: 
          description: Subscription validity delay in millisecond 
          type: integer
@@ -649,7 +655,7 @@ components:
          example: "fa8bbe40-8052-11ec-a8a3-0242ac120002"
        mode:
          description: Mode representing the context of the Relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
          $ref: '../common/commonopenapi.yaml#/components/schemas/Mode_WorldAnalysis'
          $ref: '#/components/schemas/Mode_WorldAnalysis'
        validity:
          type: integer
          example: 20000
+39 −96
Original line number Diff line number Diff line
@@ -110,8 +110,10 @@ paths:
                    format: uuid
                    example: "fa8bbe40-8052-11ec-a8a3-0242ac120002"
                  mode:
                    $ref: '../common/commonopenapi.yaml#/components/schemas/Mode_WorldStorage'

                    $ref: '#/components/schemas/Mode_WorldStorage'
                  required:
                    - uuid
                    - mode
        - in: query
          name: capabilities
          description: the list of all trackables and his encoding structure associated representing the supported data of the User
@@ -169,19 +171,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': 
@@ -208,12 +200,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': 
@@ -241,12 +228,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'

@@ -276,6 +258,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':
@@ -300,12 +284,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':
@@ -335,19 +314,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': 
@@ -374,12 +343,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': 
@@ -407,12 +373,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'

@@ -442,6 +403,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':
@@ -466,12 +429,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':
@@ -501,19 +459,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': 
@@ -540,12 +488,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': 
@@ -573,12 +518,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'

@@ -608,6 +548,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':
@@ -632,12 +574,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':
@@ -651,6 +588,12 @@ components:
    # Reusable schemas (data models)
    #-------------------------------
      schemas:
        Mode_WorldStorage:
          description: Mode representing the context of the relocalization information (AR device to WorldAnchor/Trackable or WorldAnchor/Trackable to AR device)
          type: string
          enum: [TRACKABLES_TO_REQUEST, REQUEST_TO_TRACKABLES]
          example: TRACKABLES_TO_REQUEST
        
        RelocalizationInformation:
            description: An element representing all information needed in relation with a Trackable or a WorldAnchor.
            type: object
@@ -673,7 +616,7 @@ components:
                    Transform3D:
                      $ref : '../common/commonopenapi.yaml#/components/schemas/Transform3D'
                    mode:
                      $ref: '../common/commonopenapi.yaml#/components/schemas/Mode_WorldStorage'
                      $ref: '#/components/schemas/Mode_WorldStorage'

        Trackable:
          description: An element representing a Trackable object in the real world.