diff --git a/API/openapi.yaml b/API/openapi.yaml index 4d6b7de6da0f2bef14d1e65c0d7f2fc50688e320..5bbc3faa0b176a568e85c29571f44726c42823f5 100644 --- a/API/openapi.yaml +++ b/API/openapi.yaml @@ -16,7 +16,7 @@ openapi: "3.0.0" info: - version: 0.0.6 + version: 1.0.0 title: World Storage API description: API ensuring interoperability between an authoring tool and a World Storage service license: @@ -77,11 +77,7 @@ 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 + description: OK, return the UUID of the Trackable defined by the world storage. '201': description: Null response. '400': @@ -90,6 +86,28 @@ paths: $ref: '#/components/responses/409_NotEmptyUUID' 'default': $ref: '#/components/responses/4xx_UnexpectedError' + put: + summary: Modify a Trackable. + operationId: modifyTrackable + description: Modify an existing Trackable given a json object containing all the required informations.
**Please note that ID of the object is required in the JSON** + tags: + - Trackables + requestBody: + description: The Trackable to be modified in the world storage. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/Trackable' + responses: + '200': + description: OK, return the UUID of the modified Trackable. + '400': + $ref: '#/components/responses/400_BadRequest' + '404': + $ref: '#/components/responses/404_NotFoundUUID' + 'default': + $ref: '#/components/responses/4xx_UnexpectedError' get: summary: Return all the Trackables. operationId: getTrackables @@ -112,7 +130,7 @@ paths: /trackables/{trackableUUID}: get: - summary: Find a trackable by its UUID. + summary: Find a Trackable by its UUID. operationId: getTrackableById description: Get a single Trackable stored in the world storage from its ID. tags: @@ -177,11 +195,7 @@ 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 + description: OK, return the UUID of the World Anchor defined by the world storage. '201': description: Null response. '400': @@ -190,6 +204,28 @@ paths: $ref: '#/components/responses/409_NotEmptyUUID' 'default': $ref: '#/components/responses/4xx_UnexpectedError' + put: + summary: Modify a World Anchor. + operationId: modifyWorldAnchor + description: Modify an existing World Anchor given a json object containing all the required informations.
**Please note that ID of the object is required in the JSON** + tags: + - World Anchors + requestBody: + description: The World Anchor to be modified in the world storage. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/WorldAnchor' + responses: + '200': + description: OK, return the UUID of the modified World Anchor. + '400': + $ref: '#/components/responses/400_BadRequest' + '404': + $ref: '#/components/responses/404_NotFoundUUID' + 'default': + $ref: '#/components/responses/4xx_UnexpectedError' get: summary: Return all the World Anchors. operationId: getWorldAnchors @@ -290,6 +326,28 @@ paths: $ref: '#/components/responses/409_NotEmptyUUID' 'default': $ref: '#/components/responses/4xx_UnexpectedError' + put: + summary: Modify a World Link. + operationId: modifyWorldLink + description: Modify an existing World Link given a json object containing all the required informations.
**Please note that ID of the object is required in the JSON** + tags: + - World Links + requestBody: + description: The World Link to be modified in the world storage. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/WorldLink' + responses: + '200': + description: OK, return the UUID of the modified World Link. + '400': + $ref: '#/components/responses/400_BadRequest' + '404': + $ref: '#/components/responses/404_NotFoundUUID' + 'default': + $ref: '#/components/responses/4xx_UnexpectedError' get: summary: Return all World Links. description: Get all the World Links currently being stored in the world storage.