Loading API/common/commonopenapi.yaml +19 −12 Original line number Diff line number Diff line Loading @@ -75,12 +75,19 @@ example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2V4YW1wbGUuYXV0aDAuY29tLyIsImF1ZCI6Imh0dHBzOi8vYXBpLmV4YW1wbGUuY29tL2NhbGFuZGFyL3YxLyIsInN1YiI6InVzcl8xMjMiLCJpYXQiOjE0NTg3ODU3OTYsImV4cCI6MTQ1ODg3MjE5Nn0.CA7eaHjIHz5NxeIJoFK9krqaeZrPLwmMmgI_XiQiIkQ description: A string representing the token of the User. Success: type: object properties: message: type: string example: "Success 2xx" Error: type: object properties: message: type: string example: "Error 406" example: "Error 4xx" SessionID: type: string Loading Loading @@ -156,7 +163,7 @@ content: application/json: schema: $ref: '#/components/schemas/Error' $ref: '#/components/schemas/Success' example: "Success request" 200_UuidResponse: Loading @@ -164,17 +171,9 @@ content: application/json: schema: $ref: '#/components/schemas/Error' $ref: '#/components/schemas/Success' example: "777266da-e286-11ec-8fea-0242ac120002" 201_NullResponse: description: Null response. content: application/json: schema: $ref: '#/components/schemas/Error' example: "Null response" ##################### # 3xx : Redirection # ##################### Loading @@ -198,6 +197,14 @@ $ref: '#/components/schemas/Error' example: "The format of the UUID is incorrect" 401_NullResponse: description: Null response. content: application/json: schema: $ref: '#/components/schemas/Error' example: "Null response" 403_Forbidden: description: Not allowed. content: Loading API/worldanalysis/worldanalysisopenapi.yaml +18 −1 Original line number Diff line number Diff line # Copyright 2022 ETSI. Licensed under the BSD-3-Clause license # API for the Augmented Reality Framework (ARF) # Working group: ETSI ISG ARF # STF group: STF620 (validation) # # References: # - Explaination UUID: https://en.wikipedia.org/wiki/Universally_unique_identifier / https://fr.wikipedia.org/wiki/Universally_unique_identifier # - UUID formats: 8-4-4-4-12 format string, lower case (but case insensitive on input) # - UUID RFC4122: https://datatracker.ietf.org/doc/html/rfc4122#section-3 # - online UUID generator: https://www.uuidgenerator.net/ # - Rules for RESTful error code RFC2616: https://datatracker.ietf.org/doc/html/rfc2616#section-10 # - Guide: https://restfulapi.net/http-status-codes/ # # Last Version: 06.09.2024 openapi: "3.0.0" info: version: 2.0.1 version: 2.0.2 title: World Analysis API description: API ensuring interoperability between Scene Management and a World Analysis service license: name: BSD-3-clause url: https://opensource.org/licenses/BSD-3-Clause servers: - url: https://localhost:44301 - url: http://localhost:8080 - url: https://analysis.etsi.hhi.fraunhofer.de tags: - name: default Loading API/worldstorage/worldstorageopenapi.yaml +17 −27 Original line number Diff line number Diff line Loading @@ -11,12 +11,12 @@ # - Rules for RESTful error code RFC2616: https://datatracker.ietf.org/doc/html/rfc2616#section-10 # - Guide: https://restfulapi.net/http-status-codes/ # # Last Version: 01.06.2022 # Last Version: 06.09.2024 openapi: "3.0.0" info: version: 2.0.1 version: 2.0.2 title: World Storage API description: API ensuring interoperability between an authoring tool and a World Storage service license: Loading Loading @@ -171,8 +171,6 @@ paths: responses: '200': $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' '409': Loading Loading @@ -224,14 +222,14 @@ paths: application/json: schema: type: object title: Trackables title: TrackablesResponse properties: trackables: type: array items: $ref: "#/components/schemas/Trackable" '201': $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' default: $ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError' Loading Loading @@ -261,10 +259,10 @@ 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' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' '404': $ref: '../common/commonopenapi.yaml#/components/responses/404_NotFoundUUID' delete: Loading Loading @@ -318,8 +316,6 @@ paths: responses: '200': $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' '409': Loading Loading @@ -347,8 +343,6 @@ paths: responses: '200': $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': Loading @@ -373,14 +367,14 @@ paths: application/json: schema: type: object title: WorldAnchors title: WorldAnchorsResponse properties: worldAnchors: type : array items : $ref: "#/components/schemas/WorldAnchor" '201': $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' default: $ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError' Loading Loading @@ -410,10 +404,10 @@ 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' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' '404': $ref: '../common/commonopenapi.yaml#/components/responses/404_NotFoundUUID' delete: Loading Loading @@ -467,8 +461,6 @@ paths: responses: '200': $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' '409': Loading Loading @@ -496,8 +488,6 @@ paths: responses: '200': $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': Loading @@ -522,14 +512,14 @@ paths: application/json: schema: type: object title: WorldLinks title: WorldLinksResponse properties: worldLinks: type : array items : $ref: "#/components/schemas/WorldLink" '201': $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' default: $ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError' Loading Loading @@ -559,10 +549,10 @@ 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' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' '404': $ref: '../common/commonopenapi.yaml#/components/responses/404_NotFoundUUID' delete: Loading Loading
API/common/commonopenapi.yaml +19 −12 Original line number Diff line number Diff line Loading @@ -75,12 +75,19 @@ example: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJodHRwczovL2V4YW1wbGUuYXV0aDAuY29tLyIsImF1ZCI6Imh0dHBzOi8vYXBpLmV4YW1wbGUuY29tL2NhbGFuZGFyL3YxLyIsInN1YiI6InVzcl8xMjMiLCJpYXQiOjE0NTg3ODU3OTYsImV4cCI6MTQ1ODg3MjE5Nn0.CA7eaHjIHz5NxeIJoFK9krqaeZrPLwmMmgI_XiQiIkQ description: A string representing the token of the User. Success: type: object properties: message: type: string example: "Success 2xx" Error: type: object properties: message: type: string example: "Error 406" example: "Error 4xx" SessionID: type: string Loading Loading @@ -156,7 +163,7 @@ content: application/json: schema: $ref: '#/components/schemas/Error' $ref: '#/components/schemas/Success' example: "Success request" 200_UuidResponse: Loading @@ -164,17 +171,9 @@ content: application/json: schema: $ref: '#/components/schemas/Error' $ref: '#/components/schemas/Success' example: "777266da-e286-11ec-8fea-0242ac120002" 201_NullResponse: description: Null response. content: application/json: schema: $ref: '#/components/schemas/Error' example: "Null response" ##################### # 3xx : Redirection # ##################### Loading @@ -198,6 +197,14 @@ $ref: '#/components/schemas/Error' example: "The format of the UUID is incorrect" 401_NullResponse: description: Null response. content: application/json: schema: $ref: '#/components/schemas/Error' example: "Null response" 403_Forbidden: description: Not allowed. content: Loading
API/worldanalysis/worldanalysisopenapi.yaml +18 −1 Original line number Diff line number Diff line # Copyright 2022 ETSI. Licensed under the BSD-3-Clause license # API for the Augmented Reality Framework (ARF) # Working group: ETSI ISG ARF # STF group: STF620 (validation) # # References: # - Explaination UUID: https://en.wikipedia.org/wiki/Universally_unique_identifier / https://fr.wikipedia.org/wiki/Universally_unique_identifier # - UUID formats: 8-4-4-4-12 format string, lower case (but case insensitive on input) # - UUID RFC4122: https://datatracker.ietf.org/doc/html/rfc4122#section-3 # - online UUID generator: https://www.uuidgenerator.net/ # - Rules for RESTful error code RFC2616: https://datatracker.ietf.org/doc/html/rfc2616#section-10 # - Guide: https://restfulapi.net/http-status-codes/ # # Last Version: 06.09.2024 openapi: "3.0.0" info: version: 2.0.1 version: 2.0.2 title: World Analysis API description: API ensuring interoperability between Scene Management and a World Analysis service license: name: BSD-3-clause url: https://opensource.org/licenses/BSD-3-Clause servers: - url: https://localhost:44301 - url: http://localhost:8080 - url: https://analysis.etsi.hhi.fraunhofer.de tags: - name: default Loading
API/worldstorage/worldstorageopenapi.yaml +17 −27 Original line number Diff line number Diff line Loading @@ -11,12 +11,12 @@ # - Rules for RESTful error code RFC2616: https://datatracker.ietf.org/doc/html/rfc2616#section-10 # - Guide: https://restfulapi.net/http-status-codes/ # # Last Version: 01.06.2022 # Last Version: 06.09.2024 openapi: "3.0.0" info: version: 2.0.1 version: 2.0.2 title: World Storage API description: API ensuring interoperability between an authoring tool and a World Storage service license: Loading Loading @@ -171,8 +171,6 @@ paths: responses: '200': $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' '409': Loading Loading @@ -224,14 +222,14 @@ paths: application/json: schema: type: object title: Trackables title: TrackablesResponse properties: trackables: type: array items: $ref: "#/components/schemas/Trackable" '201': $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' default: $ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError' Loading Loading @@ -261,10 +259,10 @@ 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' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' '404': $ref: '../common/commonopenapi.yaml#/components/responses/404_NotFoundUUID' delete: Loading Loading @@ -318,8 +316,6 @@ paths: responses: '200': $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' '409': Loading Loading @@ -347,8 +343,6 @@ paths: responses: '200': $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': Loading @@ -373,14 +367,14 @@ paths: application/json: schema: type: object title: WorldAnchors title: WorldAnchorsResponse properties: worldAnchors: type : array items : $ref: "#/components/schemas/WorldAnchor" '201': $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' default: $ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError' Loading Loading @@ -410,10 +404,10 @@ 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' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' '404': $ref: '../common/commonopenapi.yaml#/components/responses/404_NotFoundUUID' delete: Loading Loading @@ -467,8 +461,6 @@ paths: responses: '200': $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' '409': Loading Loading @@ -496,8 +488,6 @@ paths: responses: '200': $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': Loading @@ -522,14 +512,14 @@ paths: application/json: schema: type: object title: WorldLinks title: WorldLinksResponse properties: worldLinks: type : array items : $ref: "#/components/schemas/WorldLink" '201': $ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' default: $ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError' Loading Loading @@ -559,10 +549,10 @@ 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' '401': $ref: '../common/commonopenapi.yaml#/components/responses/401_NullResponse' '404': $ref: '../common/commonopenapi.yaml#/components/responses/404_NotFoundUUID' delete: Loading