Merge pull request #6 from giros-dit/1.6.1-ops-context-info-provision-rev (4a610580) · Commits · CIM - Context Information Management / NGSI-LD OpenAPI

ngsi-ld-api.yaml

+55 −26

Original line number	Diff line number	Diff line
		@@ -58,11 +58,11 @@ paths:
		application/json+ld:
		schema:
		allOf:
		- $ref: '#/components/schemas/Entity'
		- type: object
		properties:
		'@context':
		$ref: '#/components/schemas/LdContext'
		- $ref: '#/components/schemas/Entity'
		- required:
		- id
		- type
		@@ -292,7 +292,7 @@ paths:
		summary: \|
		Entity merge by id
		description: \|
		5.6.17 Merge entity.
		5.6.17 Merge Entity.

		This operation allows modification of an existing NGSI-LD Entity aligning to the JSON Merge Patch
		processing rules defined in IETF RFC 7396 by adding new Attributes (Properties or Relationships)
		@@ -328,11 +328,11 @@ paths:
		application/json+ld:
		schema:
		allOf:
		- $ref: '#/components/schemas/Entity'
		- type: object
		properties:
		'@context':
		$ref: '#/components/schemas/LdContext'
		- $ref: '#/components/schemas/Entity'
		- required:
		- '@context'
		responses:
		@@ -354,7 +354,7 @@ paths:
		summary: \|
		Entity replacement by id
		description: \|
		5.6.18 Replace entity.
		5.6.18 Replace Entity.

		This operation allows the modification of an existing NGSI-LD Entity
		by replacing all of the Attributes (Properties or Relationships).
		@@ -377,11 +377,11 @@ paths:
		application/json+ld:
		schema:
		allOf:
		- $ref: '#/components/schemas/Entity'
		- type: object
		properties:
		'@context':
		$ref: '#/components/schemas/LdContext'
		- $ref: '#/components/schemas/Entity'
		- required:
		- '@context'
		responses:
		@@ -403,9 +403,9 @@ paths:
		tags:
		- Context Information Provision
		summary: \|
		Append attributes to Entity
		Append Attributes to Entity
		description: \|
		5.6.3 Append Entity attributes.
		5.6.3 Append Entity Attributes.

		This operation allows modifying an NGSI-LD Entity by adding
		new attributes (Properties or Relationships).
		@@ -430,11 +430,11 @@ paths:
		application/json+ld:
		schema:
		allOf:
		- $ref: '#/components/schemas/Entity'
		- type: object
		properties:
		'@context':
		$ref: '#/components/schemas/LdContext'
		- $ref: '#/components/schemas/Entity'
		- required:
		- '@context'
		responses:
		@@ -455,9 +455,9 @@ paths:
		tags:
		- Context Information Provision
		summary: \|
		Update attributes of an Entity
		Update Attributes of an Entity
		description: \|
		5.6.2 Update Entity attributes.
		5.6.2 Update Entity Attributes.

		This operation allows modifying an existing NGSI-LD Entity by updating
		already existing Attributes (Properties or Relationships).
		@@ -480,11 +480,11 @@ paths:
		application/json+ld:
		schema:
		allOf:
		- $ref: '#/components/schemas/Entity'
		- type: object
		properties:
		'@context':
		$ref: '#/components/schemas/LdContext'
		- $ref: '#/components/schemas/Entity'
		- required:
		- '@context'
		responses:
		@@ -505,9 +505,9 @@ paths:
		tags:
		- Context Information Provision
		summary: \|
		Partial Attribute update
		Partial Attribute Update
		description: \|
		5.6.4 Partial Attribute update.
		5.6.4 Partial Attribute Update.

		This operation allows performing a partial update on an NGSI-LD Entity's Attribute (Property or Relationship).
		A partial update only changes the elements provided in an Entity Fragment, leaving the rest as they are.
		@@ -545,6 +545,9 @@ paths:
		Attribute delete
		description: \|
		5.6.5 Delete Entity Attribute.

		This operation allows deleting an NGSI-LD Entity's Attribute (Property or Relationship).
		The Attribute itself and all its children shall be deleted.
		operationId: deleteAttrs
		parameters:
		# Path params
		@@ -577,7 +580,7 @@ paths:
		summary: \|
		Attribute replace
		description: \|
		5.6.19 Attribute replace.
		5.6.19 Attribute Replace.

		This operation allows the replacement of a single Attribute (Property or Relationship)
		within an NGSI-LD Entity.
		@@ -946,6 +949,8 @@ paths:
		description: \|
		A response body containing a list of subscriptions.
		headers:
		NGSILD-Tenant:
		$ref: '#/components/headers/NGSILD-Tenant'
		NGSILD-Results-Count:
		$ref: '#/components/headers/NGSILD-Results-Count'
		content:
		@@ -1000,6 +1005,8 @@ paths:
		description: \|
		A response body containing the JSON-LD representation of the target subscription.
		headers:
		NGSILD-Tenant:
		$ref: '#/components/headers/NGSILD-Tenant'
		NGSILD-Warning:
		$ref: '#/components/headers/NGSILD-Warning'
		content:
		@@ -1809,7 +1816,7 @@ paths:
		responses:
		'201':
		description: \|
		The HTTP response shall include a "Location" HTTP header that contains
		Upon creation success, the HTTP response shall include a "Location" HTTP header that contains
		the resource URI of the created entity resource.
		headers:
		NGSILD-Tenant:
		@@ -2039,7 +2046,7 @@ paths:
		description: \|
		5.6.13 Delete Attributes from Temporal Representation of an Entity.

		This operation allows deleting an NGSI-LD Entity's Attribute (Property or Relationship).
		This operation allows deleting an Attribute (Property or Relationship) of the Temporal Representation of an Entity.
		The Attribute itself and all its children shall be deleted.
		operationId: deleteAttrsTemporal
		parameters:
		@@ -2091,7 +2098,7 @@ paths:
		- $ref: '#/components/parameters/Headers.Link'
		- $ref: '#/components/parameters/Headers.ngsildTenant'
		requestBody:
		description: Entity Fragment containing the elements of the attribute to be updated.
		description: EntityTemporal Fragment containing a complete representation of the Attribute instance to be replaced.
		$ref: '#/components/requestBodies/EntityTemporalFragment'
		responses:
		'204':
		@@ -3214,17 +3221,17 @@ components:
		application/json+ld:
		schema:
		allOf:
		- type: object
		properties:
		'@context':
		$ref: '#/components/schemas/LdContext'
		- oneOf:
		- $ref: '#/components/schemas/Property'
		- $ref: '#/components/schemas/Relationship'
		- $ref: '#/components/schemas/GeoProperty'
		- $ref: '#/components/schemas/LanguageProperty'
		- type: object
		required:
		- required:
		- '@context'
		properties:
		'@context':
		$ref: '#/components/schemas/LdContext'
		EntityTemporal:
		content:
		application/json:
		@@ -3236,11 +3243,11 @@ components:
		application/json+ld:
		schema:
		allOf:
		- $ref: '#/components/schemas/EntityTemporal'
		- type: object
		properties:
		'@context':
		$ref: '#/components/schemas/LdContext'
		- $ref: '#/components/schemas/EntityTemporal'
		- required:
		- id
		- type
		@@ -3253,11 +3260,11 @@ components:
		application/json+ld:
		schema:
		allOf:
		- $ref: '#/components/schemas/EntityTemporal'
		- type: object
		properties:
		'@context':
		$ref: '#/components/schemas/LdContext'
		- $ref: '#/components/schemas/EntityTemporal'
		- required:
		- '@context'
		QueryTemporal:
		@@ -3942,6 +3949,27 @@ components:
		the EntityTemporal by using the "Simplified Temporal Representation of an Entity",
		as defined in clause 4.5.9.
		properties:
		id:
		description: \|
		Entity id.
		type: string
		format: uri
		type:
		description: \|
		Entity Type(s). Both short hand string(s) (type name) or URI(s) are allowed.
		oneOf:
		- type: string
		- type: array
		items:
		type: string
		scope:
		description: \|
		Scope.
		oneOf:
		- type: string
		- type: array
		items:
		type: string
		location:
		description: \|
		Default geospatial Property of an entity. See clause 4.7.
		@@ -5216,7 +5244,8 @@ components:
		$ref: '#/components/schemas/BatchOperationResult'
		MultiStatus.UpdateResult:
		description: \|
		Only the Attributes included in the response payload body were successfully appended.
		Only the Attributes included in the response payload body were successfully appended. If no Attributes
		were successfully updated the updated array of UpdateResult (see clause 5.2.18) will be empty.

		If the entity input data matches to a registration, the relevant parts of the request are
		forwarded as a distributed operation.