Replace Uid and id by UUID where it's necessary (eec9df4c) · Commits · ARF - Augmented Reality Framework / ARF005

API/openapi.yaml

+64 −85

Original line number	Diff line number	Diff line
		openapi: "3.0.0"
		info:
		version: 0.0.3
		version: 0.0.4
		title: World Storage API
		description: API ensuring interoperability between an authoring tool and a World Storage service
		license:
		@@ -57,13 +57,16 @@ paths:
		application/json:
		schema:
		$ref: '#/components/schemas/Error'
		# Check 2xx, 4xx, 5xx...
		'401':
		$ref: '#/components/responses/UUID'
		get:
		summary: returns the list of all trackables defined by the world storage.
		operationId: getTrackables
		tags:
		- trackables
		responses:
		200:
		'200':
		description: OK returns all the Trackables defined by the world storage.
		content:
		application/json:
		@@ -71,7 +74,7 @@ paths:
		type : array
		items :
		$ref: "#/components/schemas/Trackable"
		201:
		'201':
		description: Null response
		default:
		description: unexpected error
		@@ -79,16 +82,17 @@ paths:
		application/json:
		schema:
		$ref: "#/components/schemas/Error"
		/trackables/{trackableId}:

		/trackables/{trackableUUID}:
		get:
		summary: Find a trackable by his ID
		summary: Find a trackable by its UUID
		operationId: getTrackableById
		tags:
		- trackables
		parameters:
		- name: trackableId
		- name: trackableUUID
		in: path
		description: ID of the trackable to retrieve
		description: UUID of the trackable to retrieve
		required: true
		schema:
		type: string
		@@ -100,7 +104,7 @@ paths:
		schema:
		$ref: '#/components/schemas/Trackable'
		'400':
		description: Invalid ID supplied
		description: Invalid UUID supplied
		'404':
		description: Trackable not found
		delete:
		@@ -109,9 +113,9 @@ paths:
		tags:
		- trackables
		parameters:
		- name: trackableId
		- name: trackableUUID
		in: path
		description: trackable id to delete
		description: trackable UUID to delete
		required: true
		schema:
		type: string
		@@ -119,7 +123,7 @@ paths:
		'200':
		description: OK
		'400':
		description: Invalid ID supplied
		description: Invalid UUID supplied
		'404':
		description: trackable not found
		/worldAnchors:
		@@ -175,16 +179,16 @@ paths:
		application/json:
		schema:
		$ref: "#/components/schemas/Error"
		/worldAnchors/{worldAnchorId}:
		/worldAnchors/{worldAnchorUUID}:
		get:
		summary: Find a world anchor by his ID
		summary: Find a world anchor by his UUID
		operationId: getWorldAnchorById
		tags:
		- world anchors
		parameters:
		- name: worldAnchorId
		- name: trackableUUID
		in: path
		description: ID of the world anchor to retrieve
		description: UUID of the world anchor to retrieve
		required: true
		schema:
		type: string
		@@ -196,7 +200,7 @@ paths:
		schema:
		$ref: '#/components/schemas/WorldAnchor'
		'400':
		description: Invalid ID supplied
		description: Invalid UUID supplied
		'404':
		description: World Anchor not found
		delete:
		@@ -205,9 +209,9 @@ paths:
		tags:
		- world anchors
		parameters:
		- name: worldAnchorId
		- name: trackableUUID
		in: path
		description: world anchor id to delete
		description: world anchor UUID to delete
		required: true
		schema:
		type: string
		@@ -215,7 +219,7 @@ paths:
		'200':
		description: OK
		'400':
		description: Invalid ID supplied
		description: Invalid UUID supplied
		'404':
		description: World anchor not found
		/worldLinks:
		@@ -271,14 +275,14 @@ paths:
		application/json:
		schema:
		$ref: "#/components/schemas/Error"
		/worldLinks/{linkId}:
		/worldLinks/{worldLinkUUID}:
		get:
		summary: Find a link by his ID
		operationId: getWorldLinkById
		tags:
		- world links
		parameters:
		- name: worldLinkId
		- name: worldLinkUUID
		in: path
		description: ID of the link to retrieve
		required: true
		@@ -301,7 +305,7 @@ paths:
		tags:
		- world links
		parameters:
		- name: linkId
		- name: worldLinkUUID
		in: path
		description: link id to delete
		required: true
		@@ -319,22 +323,22 @@ components:
		Trackable:
		type: object
		required:
		- creatorUID
		- creatorUUID
		- trackableType
		- trackableEncodingInformation
		- trackablePayload
		- localCRS
		- unit
		- trackableDimension
		- trackableSize
		- keyvalueTagList
		properties:
		UID:
		description: A Universally Unique IDentifier identifying the trackable
		UUID:
		description: A Universally Unique IDentifier identifying the trackable (RFC 4122)
		type: string
		format: uuid
		example: fa8bbe40-8052-11ec-a8a3-0242ac120002
		creatorUID:
		description: A Universally Unique IDentifier identifying the creator of the trackable
		creatorUUID:
		description: A Universally Unique IDentifier identifying the creator of the trackable (a person, a team or a company)
		type: string
		format: uuid
		example: c75f6324-77a0-11ec-90d6-0242ac120003
		@@ -344,7 +348,6 @@ components:
		enum: [FIDUCIAL_MARKER, IMAGE_MARKER, MAP, OTHER]
		example: FIDUCIAL_MARKER
		trackableEncodingInformation:
		description: Identifies targeted framework and version of the format.
		$ref: '#/components/schemas/EncodingInformationStructure'
		trackablePayload:
		description: The data provided to create the trackable in a specific format handled by the World Storage service.
		@@ -352,106 +355,77 @@ components:
		format: byte
		example: "10110101"
		localCRS:
		description: Coordinate reference system
		$ref: '#/components/schemas/CRS'
		example: [-2, 1, -3, 4,
		4, 4, 4, 2,
		1, 0, -2, 1,
		-1, -2, 0, 0]
		$ref: '#/components/schemas/Transform3D'
		unit:
		description: Unit of length
		$ref: '#/components/schemas/UnitSystem'
		trackableDimension:
		description: Bounding box of the Trackable, {width, length, 0} for 2D trackables, {width, length, depth} for 3D trackables
		$ref: '#/components/schemas/Dimension'
		example: [1,5,0]
		trackableSize:
		$ref: '#/components/schemas/Size'
		keyvalueTags:
		description: List of additional parameters to be stored
		$ref: '#/components/schemas/KeyvalueTagList'
		example: { "author" : ["james","donovan"], "image" : ["skater"]}
		WorldAnchor:
		type: object
		required:
		- creatorUID
		- creatorUUID
		- localCRS
		- unit
		- worldAnchorDimension
		- worldAnchorSize
		- keyvalueTagList
		properties:
		UID:
		UUID:
		description: A Universally Unique IDentifier identifying the world anchor
		type: string
		format: uuid
		example: ce8ccd80-56ee-2a5c-a8a3-0242ac150d002
		creatorUID:
		creatorUUID:
		description: A Universally Unique IDentifier identifying the creator of the world anchor
		type: string
		format: uuid
		example: c75f6324-77a0-11ec-90d6-0242ac120003
		localCRS:
		description: Coordinate reference system
		$ref: '#/components/schemas/CRS'
		example: [-2, 1, -3, 4,
		4, 4, 4, 2,
		1, 0, -2, 1,
		-1, -2, 0, 0]
		$ref: '#/components/schemas/Transform3D'
		unit:
		description: Unit of length
		$ref: '#/components/schemas/UnitSystem'
		worldAnchorDimension:
		description: Bounding box {width, length, depth}
		$ref: '#/components/schemas/Dimension'
		example: [1,5,0]
		worldAnchorSize:
		$ref: '#/components/schemas/Size'
		keyvalueTags:
		description: List of additional parameters to be stored
		$ref: '#/components/schemas/KeyvalueTagList'
		example: { "Place" : ["Museum 1"], "room" : ["B4"]}
		WorldLink:
		type: object
		required:
		- creatorUID
		- UIDA
		- UIDB
		- localCRS
		- creatorUUID
		- UUIDFrom
		- UUIDTo
		- transform
		- unit
		- linkDimension
		- linkSize
		- keyvalueTags
		properties:
		UID:
		UUID:
		description: A Universally Unique IDentifier identifying the link
		type: string
		format: uuid
		example: ce8ccd80-56ee-2a5c-a8a3-0242ac150d002
		creatorUID:
		creatorUUID:
		description: A Universally Unique IDentifier identifying the creator of the link
		type: string
		format: uuid
		example: c75f6324-77a0-11ec-90d6-0242ac120003
		UIDA:
		UUIDFrom:
		description: A Universally Unique IDentifier identifying a world anchor or trackable
		type: string
		format: uuid
		example: ce8ccd80-56ee-2a5c-a8a3-0242ac150d002
		UIDB:
		UUIDTo:
		description: A Universally Unique IDentifier identifying a world anchor or trackable
		type: string
		format: uuid
		example: ce8ccd80-56ee-2a5c-a8a3-0242ac150d002
		localCRS:
		description: Coordinate reference system
		$ref: '#/components/schemas/CRS'
		example: [-2, 1, -3, 4,
		4, 4, 4, 2,
		1, 0, -2, 1,
		-1, -2, 0, 0]
		transform:
		$ref: '#/components/schemas/Transform3D'
		unit:
		description: Unit of length
		$ref: '#/components/schemas/UnitSystem'
		example: M
		linkDimension:
		description: Bounding box
		$ref: '#/components/schemas/Dimension'
		example: [1,5,0]
		linkSize:
		$ref: '#/components/schemas/Size'
		keyvalueTags:
		description: List of additional parameters to be stored
		$ref: '#/components/schemas/KeyvalueTagList'
		@@ -470,7 +444,7 @@ components:
		description: The version of the format
		type: string
		example : "1.01"
		CRS:
		Transform3D:
		description: Coordinate reference system of the world anchor, a 4*4 matrix (rowmajor) represented by a float vector
		type: array
		minItems: 16
		@@ -478,12 +452,17 @@ components:
		items:
		type: number
		format: float
		example: [-2, 1,-3, 4,
		4, 4, 4, 2,
		1, 0,-2, 1,
		-1,-2, 0, 0]
		UnitSystem:
		description: Unit of length
		type: string
		enum: [MM, CM, DM, M, DAM, HM, KM, INCH, FOOT, YARD, MILE]
		Dimension:
		description: Bounding box {width, length, depth}
		example: M
		Size:
		description: Size {width, length, depth}
		type: array
		items:
		type: number