Updating Query schema, including the pick, omit, datasetId, and entityMap... (3e63ce77) · Commits · CIM - Context Information Management / NGSI-LD OpenAPI

ngsi-ld-api.yaml

+45 −0

Original line number	Original line	Diff line number	Diff line
	@@ -5001,6 +5001,26 @@ components:
	description: \|		description: \|
	List of Attributes that shall be matched by Entities in order to be retrieved.		List of Attributes that shall be matched by Entities in order to be retrieved.
	If not present all Attributes will be retrieved.		If not present all Attributes will be retrieved.
			DEPRECATED: A synonym for a combination of the pick and q parameter.
			type: array
			items:
			type: string
			minItems: 1
			pick:
			description: \|
			When defined, every Entity within payload body is reduced down to only contain
			the specified Entity members.
			Entity member ("id", "type", "scope" or a projected Attribute name) as a valid
			attribute projection language string as per clause 4.21).
			type: array
			items:
			type: string
			minItems: 1
			omit:
			description: \|
			When defined, the specified Entity members are removed from each Entity within
			the payload. Entity member ("id", "type", "scope" or a projected Attribute name)
			as a valid attribute projection language string as per clause 4.21).
	type: array		type: array
	items:		items:
	type: string		type: string
	@@ -5028,6 +5048,31 @@ components:
	lang:		lang:
	description: Language filter to be applied to the query (clause 4.15).		description: Language filter to be applied to the query (clause 4.15).
	type: string		type: string
			containedBy:
			description: \|
			List of entity ids which have previously been encountered whilst retrieving the Entity Graph.
			Only applicable if joinLevel is present.
			Only applicable for the "Query Entities" operation (clause 5.7.2).
			type: array
			items:
			type: string
			format: uri
			minItems: 1
			datasetId:
			description: \|
			Specifies the datasetIds of the Attribute instances to be selected for each
			matched Attribute as per clause 4.5.5. Valid URIs, "@none" for including the
			default Attribute instances.
			type: array
			items:
			type: string
			format: uri
			default: "@none"
			entityMap:
			description: \|
			If true, the location of the EntityMap used in the operation is returned in the response.
			Only applicable for the "Query Entities" operation (clause 5.7.2).
			type: boolean
	required:		required:
	- type		- type
	Query.temporal:		Query.temporal: