added new api spec (94d807ec) · Commits · ARF / World Storage API Helpers / World Storage Cpp server

openapi.yaml

+39 −8

Original line number	Diff line number	Diff line
		openapi: "3.0.0"
		info:
		version: 0.0.1
		version: 0.0.2
		title: World Storage API
		description: API ensuring interoperability between an authoring tool and a World Storage service
		license:
		@@ -138,32 +138,61 @@ components:
		creatorUID:
		description: A Universally Unique IDentifier identifying the creator of the trackable
		type: string
		format: uuid
		example: c75f6324-77a0-11ec-90d6-0242ac120003
		trackableType:
		description: Extensible list of trackable types possibly handled by complient World Storage implementation
		type: string
		enum: [FIDUCIAL_MARKER, IMAGE_MARKER, MAP, OTHER]
		example: FIDUCIAL_MARKER
		trackableEncodingInformation:
		description: Identifies targeted framework and version of the format.
		$ref: '#/components/schemas/trackableEncodingInformationStructure'
		$ref: '#/components/schemas/encodingInformationStructure'
		trackablePayload:
		description: The data provided to create the trackable in a specific format handled by the World Storage service.
		type: string
		format: byte
		example: "10110101"
		localCRS:
		description: Coordinate reference system of the trackable
		type: array
		minItems: 4
		maxItems: 4
		items:
		type: array
		items:
		type: number
		format: float
		minItems: 4
		maxItems: 4
		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: [METERS, INCHES]
		enum: [MM, CM, DM, M, DAM, HM, KM, INCH, FOOT, YARD, MILE]
		example: M
		trackableDimension:
		description: Bounding box of the Trackable, {width, length, 0} for 2D trackables, {width, length, depth} for 3D trackables
		type: array
		items:
		type: number
		format: double
		minItems: 3
		maxItems: 3
		example: [1,5,0]
		keyvalueTagList:
		description: List of additional parameters to be stored with the trackable.
		type: object
		additionalProperties:
		type: array
		items:
		type: string
		trackableEncodingInformationStructure:
		minItems: 1
		example: { "author" : ["james","donovan"], "image" : ["skater"]}
		encodingInformationStructure:
		required:
		- dataFormat
		- version
		@@ -172,9 +201,11 @@ components:
		description: Identifier of the target framework
		type: string
		enum: [HOLOLENS, ARKIT, ARCORE]
		example : "HOLOLENS"
		version:
		description: The version of the format
		type: string
		example : "1.01"
		Error:
		required:
		- code