Merge branch 'feature/PutEndpoints' into 'feature/FormatSpec' (dc6a488c) · Commits · ARF - Augmented Reality Framework / ARF005

API/openapi.yaml

+70 −12

Original line number	Original line	Diff line number	Diff line
	@@ -16,7 +16,7 @@
	openapi: "3.0.0"		openapi: "3.0.0"

	info:		info:
	version: 0.0.6		version: 1.0.0
	title: World Storage API		title: World Storage API
	description: API ensuring interoperability between an authoring tool and a World Storage service		description: API ensuring interoperability between an authoring tool and a World Storage service
	license:		license:
	@@ -78,10 +78,6 @@ paths:
	responses:		responses:
	'200':		'200':
	description: OK, return the UUID of the Trackable defined by the world storage.		description: OK, return the UUID of the Trackable defined by the world storage.
	content:
	text/plain:
	schema:
	type: string
	'201':		'201':
	description: Null response.		description: Null response.
	'400':		'400':
	@@ -90,6 +86,28 @@ paths:
	$ref: '#/components/responses/409_NotEmptyUUID'		$ref: '#/components/responses/409_NotEmptyUUID'
	'default':		'default':
	$ref: '#/components/responses/4xx_UnexpectedError'		$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. <br> 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:		get:
	summary: Return all the Trackables.		summary: Return all the Trackables.
	operationId: getTrackables		operationId: getTrackables
	@@ -112,7 +130,7 @@ paths:

	/trackables/{trackableUUID}:		/trackables/{trackableUUID}:
	get:		get:
	summary: Find a trackable by its UUID.		summary: Find a Trackable by its UUID.
	operationId: getTrackableById		operationId: getTrackableById
	description: Get a single Trackable stored in the world storage from its ID.		description: Get a single Trackable stored in the world storage from its ID.
	tags:		tags:
	@@ -178,10 +196,6 @@ paths:
	responses:		responses:
	'200':		'200':
	description: OK, return the UUID of the World Anchor defined by the world storage.		description: OK, return the UUID of the World Anchor defined by the world storage.
	content:
	text/plain:
	schema:
	type: string
	'201':		'201':
	description: Null response.		description: Null response.
	'400':		'400':
	@@ -190,6 +204,28 @@ paths:
	$ref: '#/components/responses/409_NotEmptyUUID'		$ref: '#/components/responses/409_NotEmptyUUID'
	'default':		'default':
	$ref: '#/components/responses/4xx_UnexpectedError'		$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. <br> 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:		get:
	summary: Return all the World Anchors.		summary: Return all the World Anchors.
	operationId: getWorldAnchors		operationId: getWorldAnchors
	@@ -290,6 +326,28 @@ paths:
	$ref: '#/components/responses/409_NotEmptyUUID'		$ref: '#/components/responses/409_NotEmptyUUID'
	'default':		'default':
	$ref: '#/components/responses/4xx_UnexpectedError'		$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. <br> 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:		get:
	summary: Return all World Links.		summary: Return all World Links.
	description: Get all the World Links currently being stored in the world storage.		description: Get all the World Links currently being stored in the world storage.

Admin message