Commit 41445c28 authored by Jerome Royan's avatar Jerome Royan
Browse files

fix: remove references to schemas with enum, not supported by some generators

parent b01d54c0

API/common/commonopenapi.yaml

+4 −2
Original line number Diff line number Diff line
@@ -116,10 +116,12 @@ 
      Capability:

        description: An object representing a supported capability of the World Analysis and its associated metadata

        type: object

        uniqueItems: true

        properties:

          trackableType:

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

            description: Type for trackable

            type: string

            enum: [FIDUCIAL_MARKER, IMAGE_MARKER, MESH, MAP, GEOPOSE, OTHER]

            example: "FIDUCIAL_MARKER"

          encodingInformation:

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

          framerate:

API/worldstorage/worldstorageopenapi.yaml

+41 −9
Original line number Diff line number Diff line
@@ -110,7 +110,11 @@ paths: 
                    format: uuid

                    example: "fa8bbe40-8052-11ec-a8a3-0242ac120002"

                  mode:

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

                    ## reference to schema with enum is not fully supported by all generators

                    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

                  required:

                    - uuid

                    - mode
@@ -604,7 +608,11 @@ components: 
                format: uuid

                example: 89b7e1f5-dd41-4746-9279-e1ef9284fe4d

              requestType:

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

                ## reference to enum is not fully supported by all generators

                description: Trackable or Anchor

                type: string

                enum: [TRACKABLE, ANCHOR, UNKNOWN]

                example: ANCHOR

              relocObjects:

                description: an array with trackables and their transforms linking them to the requestUUID element.

                type: array
@@ -647,7 +655,11 @@ components: 
              format: uuid

              example: bd6ce7ce-7fe8-487d-a179-fddfe914f293

            trackableType:

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

              ## reference to schema with enum is not fully supported by all generators

              description: Type for trackable

              type: string

              enum: [FIDUCIAL_MARKER, IMAGE_MARKER, MESH, MAP, GEOPOSE, OTHER]

              example: "FIDUCIAL_MARKER"

            trackableEncodingInformation:      

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

            trackablePayload:
@@ -658,7 +670,11 @@ components: 
            localCRS:

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

            unit:

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

              ## reference to schema with enum is not fully supported by all generators

              description: Unit of length.

              type: string

              enum: [MM,  CM,  DM,  M,  DAM,  HM,  KM,  INCH, FOOT, YARD, MILE]

              example: M

            trackableSize:

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

            keyvalueTags:
@@ -695,7 +711,11 @@ components: 
            localCRS:

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

            unit:

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

              ## reference to schema with enum is not fully supported by all generators

              description: Unit of length.

              type: string

              enum: [MM,  CM,  DM,  M,  DAM,  HM,  KM,  INCH, FOOT, YARD, MILE]

              example: M

            worldAnchorSize:

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

            keyvalueTags:
@@ -735,13 +755,25 @@ components: 
              format: uuid

              example: 85eed503-875c-4d3d-9569-06c4859bd4cd

            typeFrom:

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

              ## reference to schema with enum is not fully supported by all generators

              description: Trackable or Anchor

              type: string

              enum: [TRACKABLE, ANCHOR, UNKNOWN]

              example: ANCHOR

            typeTo:

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

              ## reference to schema with enum is not fully supported by all generators

              description: Trackable or Anchor

              type: string

              enum: [TRACKABLE, ANCHOR, UNKNOWN]

              example: ANCHOR

            transform:

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

            unit:

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

              ## reference to schema with enum is not fully supported by all generators

              description: Unit of length.

              type: string

              enum: [MM,  CM,  DM,  M,  DAM,  HM,  KM,  INCH, FOOT, YARD, MILE]

              example: M

            keyvalueTags:

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