all responses return a json object for homogeneity, even error ones (9dfde64e) · Commits · ARF - Augmented Reality Framework / ARF

API/common/commonopenapi.yaml

+39 −16

Original line number	Original line	Diff line number	Diff line
	@@ -157,6 +157,29 @@
	#################		#################
	# 2xx : Success #		# 2xx : Success #
	#################		#################
			200_SuccessRequest:
			description: Success request.
			content:
			application/json:
			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: "Null response"

	#####################		#####################
	# 3xx : Redirection #		# 3xx : Redirection #
	@@ -168,49 +191,49 @@
	400_BadRequest:		400_BadRequest:
	description: Bad request.		description: Bad request.
	content:		content:
	text/plain:		application/json:
	schema:		schema:
	type: string		$ref: '#/components/schemas/Error'
	example: "Bad request"		example: "Bad request"

	400_InvalidUUID:		400_InvalidUUID:
	description: Invalid UUID supplied.		description: Invalid UUID supplied.
	content:		content:
	text/plain:		application/json:
	schema:		schema:
			$ref: '#/components/schemas/Error'
	example: "The format of the UUID is incorrect"		example: "The format of the UUID is incorrect"
	type: string

	403_Forbidden:		403_Forbidden:
	description: Not allowed.		description: Not allowed.
	content:		content:
	text/plain:		application/json:
	schema:		schema:
	type: string		$ref: '#/components/schemas/Error'
	example: "Not allowed"		example: "Not allowed"

	404_NotFound:		404_NotFound:
	description: Not found.		description: Not found.
	content:		content:
	text/plain:		application/json:
	schema:		schema:
	type: string		$ref: '#/components/schemas/Error'
	example: "Not found"		example: "Not found"

	404_NotFoundUUID:		404_NotFoundUUID:
	description: Not found, could not find UUID in database.		description: Not found, could not find UUID in database.
	content:		content:
	text/plain:		application/json:
	schema:		schema:
	type: string		$ref: '#/components/schemas/Error'
	example: "Element not found"		example: "Element not found"

	405_NotSupported:		405_NotSupported:
	description: Not supported.		description: Not supported.
	content:		content:
	text/plain:		application/json:
	schema:		schema:
	type: string		$ref: '#/components/schemas/Error'
	example: "Not supported"		example: "Not supported"

	4xx_UnexpectedError: # Can be referenced as '#/components/responses/GenericError'		4xx_UnexpectedError: # Can be referenced as '#/components/responses/GenericError'
	@@ -223,9 +246,9 @@
	409_NotEmptyUUID:		409_NotEmptyUUID:
	description: Invalid UUID, id must be a Nil value.		description: Invalid UUID, id must be a Nil value.
	content:		content:
	text/plain:		application/json:
	schema:		schema:
	type: string		$ref: '#/components/schemas/Error'
	example: "The element you sent has already a value and can't be sent to the world storage"		example: "The element you sent has already a value and can't be sent to the world storage"

	########################		########################

API/worldanalysis/worldanalysisopenapi.yaml

+1 −6

Original line number	Original line	Diff line number	Diff line
	@@ -355,12 +355,7 @@ paths:
	example: "bdc83e6b-a89d-4b29-9c99-e9015d448b10"		example: "bdc83e6b-a89d-4b29-9c99-e9015d448b10"
	responses:		responses:
	'200':		'200':
	description: OK, unsubcription successful.		$ref: '../common/commonopenapi.yaml#/components/responses/200_SuccessRequest'
	content:
	text/plain:
	schema:
	type: string
	example: "Subscription succesfuly deleted"
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'		$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'
	'404':		'404':

API/worldstorage/worldstorageopenapi.yaml

+28 −93

Original line number	Original line	Diff line number	Diff line
	@@ -170,19 +170,9 @@ paths:
	$ref: '#/components/schemas/Trackable'		$ref: '#/components/schemas/Trackable'
	responses:		responses:
	'200':		'200':
	description: OK, return the UUID of the Trackable defined by the world storage.		$ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'
	content:
	text/plain:
	schema:
	type: string
	example: "777266da-e286-11ec-8fea-0242ac120002"
	'201':		'201':
	description: Null response.		$ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'
	content:
	text/plain:
	schema:
	type: string
	example: ""
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'		$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'
	'409':		'409':
	@@ -209,12 +199,7 @@ paths:
	$ref: '#/components/schemas/Trackable'		$ref: '#/components/schemas/Trackable'
	responses:		responses:
	'200':		'200':
	description: OK, return the UUID of the modified Trackable.		$ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'
	content:
	text/plain:
	schema:
	type: string
	example: "777266da-e286-11ec-8fea-0242ac120002"
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'		$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'
	'404':		'404':
	@@ -246,12 +231,7 @@ paths:
	items:		items:
	$ref: "#/components/schemas/Trackable"		$ref: "#/components/schemas/Trackable"
	'201':		'201':
	description: Null response.		$ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'
	content:
	text/plain:
	schema:
	type: string
	example: ""
	default:		default:
	$ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError'		$ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError'

	@@ -281,6 +261,8 @@ paths:
	application/json:		application/json:
	schema:		schema:
	$ref: '#/components/schemas/Trackable'		$ref: '#/components/schemas/Trackable'
			'201':
			$ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'		$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'
	'404':		'404':
	@@ -305,12 +287,7 @@ paths:
	format: uuid		format: uuid
	responses:		responses:
	'200':		'200':
	description: OK, delete successful.		$ref: '../common/commonopenapi.yaml#/components/responses/200_SuccessRequest'
	content:
	text/plain:
	schema:
	type: string
	example: "Element succesfully deleted"
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'		$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'
	'404':		'404':
	@@ -340,19 +317,9 @@ paths:
	$ref: '#/components/schemas/WorldAnchor'		$ref: '#/components/schemas/WorldAnchor'
	responses:		responses:
	'200':		'200':
	description: OK, return the UUID of the World Anchor defined by the world storage.		$ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'
	content:
	text/plain:
	schema:
	type: string
	example: "777266da-e286-11ec-8fea-0242ac120002"
	'201':		'201':
	description: Null response.		$ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'
	content:
	text/plain:
	schema:
	type: string
	example: ""
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'		$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'
	'409':		'409':
	@@ -379,12 +346,9 @@ paths:
	$ref: '#/components/schemas/WorldAnchor'		$ref: '#/components/schemas/WorldAnchor'
	responses:		responses:
	'200':		'200':
	description: OK, return the UUID of the modified World Anchor.		$ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'
	content:		'201':
	text/plain:		$ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'
	schema:
	type: string
	example: "777266da-e286-11ec-8fea-0242ac120002"
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'		$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'
	'404':		'404':
	@@ -416,12 +380,7 @@ paths:
	items :		items :
	$ref: "#/components/schemas/WorldAnchor"		$ref: "#/components/schemas/WorldAnchor"
	'201':		'201':
	description: Null response.		$ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'
	content:
	text/plain:
	schema:
	type: string
	example: ""
	default:		default:
	$ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError'		$ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError'

	@@ -451,6 +410,8 @@ paths:
	application/json:		application/json:
	schema:		schema:
	$ref: '#/components/schemas/WorldAnchor'		$ref: '#/components/schemas/WorldAnchor'
			'201':
			$ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'		$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'
	'404':		'404':
	@@ -475,12 +436,7 @@ paths:
	format: uuid		format: uuid
	responses:		responses:
	'200':		'200':
	description: OK, delete successful.		$ref: '../common/commonopenapi.yaml#/components/responses/200_SuccessRequest'
	content:
	text/plain:
	schema:
	type: string
	example: "Element succesfuly deleted"
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'		$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'
	'404':		'404':
	@@ -510,19 +466,9 @@ paths:
	$ref: '#/components/schemas/WorldLink'		$ref: '#/components/schemas/WorldLink'
	responses:		responses:
	'200':		'200':
	description: OK, return the UUID of the World Link defined by the world storage.		$ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'
	content:
	text/plain:
	schema:
	type: string
	example: "777266da-e286-11ec-8fea-0242ac120002"
	'201':		'201':
	description: Null response.		$ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'
	content:
	text/plain:
	schema:
	type: string
	example: ""
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'		$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'
	'409':		'409':
	@@ -549,12 +495,9 @@ paths:
	$ref: '#/components/schemas/WorldLink'		$ref: '#/components/schemas/WorldLink'
	responses:		responses:
	'200':		'200':
	description: OK, return the UUID of the modified World Link.		$ref: '../common/commonopenapi.yaml#/components/responses/200_UuidResponse'
	content:		'201':
	text/plain:		$ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'
	schema:
	type: string
	example: "777266da-e286-11ec-8fea-0242ac120002"
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'		$ref: '../common/commonopenapi.yaml#/components/responses/400_BadRequest'
	'404':		'404':
	@@ -586,12 +529,7 @@ paths:
	items :		items :
	$ref: "#/components/schemas/WorldLink"		$ref: "#/components/schemas/WorldLink"
	'201':		'201':
	description: Null response.		$ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'
	content:
	text/plain:
	schema:
	type: string
	example: ""
	default:		default:
	$ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError'		$ref: '../common/commonopenapi.yaml#/components/responses/4xx_UnexpectedError'

	@@ -621,6 +559,8 @@ paths:
	application/json:		application/json:
	schema:		schema:
	$ref: '#/components/schemas/WorldLink'		$ref: '#/components/schemas/WorldLink'
			'201':
			$ref: '../common/commonopenapi.yaml#/components/responses/201_NullResponse'
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'		$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'
	'404':		'404':
	@@ -645,12 +585,7 @@ paths:
	format: uuid		format: uuid
	responses:		responses:
	'200':		'200':
	description: OK, delete successful.		$ref: '../common/commonopenapi.yaml#/components/responses/200_SuccessRequest'
	content:
	text/plain:
	schema:
	type: string
	example: "Element succesfully deleted"
	'400':		'400':
	$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'		$ref: '../common/commonopenapi.yaml#/components/responses/400_InvalidUUID'
	'404':		'404':