Include AttributeFragment and fix others Fragments (9e786c97) · Commits · CIM - Context Information Management / NGSI-LD API

ngsi-ld-api.yaml

+182 −67

Original line number	Diff line number	Diff line
		@@ -410,7 +410,7 @@ paths:
		tags:
		- Context Information Provision
		summary: \|
		Partial Attribute update.
		Partial Attribute update
		description: \|
		5.6.4 Partial Attribute update.

		@@ -428,8 +428,8 @@ paths:
		- $ref: '#/components/parameters/Headers.Link'
		- $ref: '#/components/parameters/Headers.ngsildTenant'
		requestBody:
		description: Entity Fragment containing the elements of the attribute to be updated.
		$ref: '#/components/requestBodies/EntityFragment'
		description: Attribute Fragment containing the elements of the attribute to be updated.
		$ref: '#/components/requestBodies/AttributeFragment'
		responses:
		'204':
		description: \|
		@@ -446,8 +446,10 @@ paths:
		delete:
		tags:
		- Context Information Provision
		summary: Attribute delete
		description: 5.6.5 Delete Entity Attribute.
		summary: \|
		Attribute delete
		description: \|
		5.6.5 Delete Entity Attribute.
		operationId: deleteAttrs
		parameters:
		# Path params
		@@ -496,7 +498,7 @@ paths:
		- $ref: '#/components/parameters/Headers.ngsildTenant'
		requestBody:
		description: Attribute Fragment replacing the previous data.
		$ref: '#/components/requestBodies/EntityFragment'
		$ref: '#/components/requestBodies/AttributeFragment'
		responses:
		'204':
		description: \|
		@@ -926,7 +928,8 @@ paths:
		post:
		tags:
		- Context Source Registration Subscription
		summary: Create subscription to Csource registration.
		summary: \|
		Create subscription to Csource registration
		description: \|
		5.11.2 Create Context Source Registration Subscription.

		@@ -963,7 +966,7 @@ paths:
		tags:
		- Context Source Registration Subscription
		summary: \|
		Retrieval of list of subscription to Csource registration.
		Retrieval of list of subscription to Csource registration
		description: \|
		5.11.5 Query Context Source Registration Subscriptions.

		@@ -1012,7 +1015,8 @@ paths:
		get:
		tags:
		- Context Source Registration Subscription
		summary: Retrieval of list of subscription to Csource registration.
		summary: \|
		Retrieval of list of subscription to Csource registration
		description: \|
		5.11.4 Retrieve Context Source Registration Subscription.

		@@ -1063,7 +1067,8 @@ paths:
		patch:
		tags:
		- Context Source Registration Subscription
		summary: Csource registration subscription update by id.
		summary: \|
		Csource registration subscription update by id
		description: \|
		5.11.3 Update Context Source Registration Subscription.

		@@ -1096,7 +1101,8 @@ paths:
		delete:
		tags:
		- Context Source Registration
		summary: Csource registration subscription deletion by id.
		summary: \|
		Csource registration subscription deletion by id
		description: \|
		5.11.6 Delete Context Source Registration Subscription.

		@@ -2826,6 +2832,30 @@ components:
		type: string
		required: false
		requestBodies:
		AttributeFragment:
		required: true
		content:
		application/json:
		schema:
		oneOf:
		- $ref: '#/components/schemas/PropertyFragment'
		- $ref: '#/components/schemas/RelationshipFragment'
		- $ref: '#/components/schemas/GeoPropertyFragment'
		- $ref: '#/components/schemas/LanguagePropertyFragment'
		application/json+ld:
		schema:
		allOf:
		- oneOf:
		- $ref: '#/components/schemas/PropertyFragment'
		- $ref: '#/components/schemas/RelationshipFragment'
		- $ref: '#/components/schemas/GeoPropertyFragment'
		- $ref: '#/components/schemas/LanguagePropertyFragment'
		- type: object
		required:
		- '@context'
		properties:
		'@context':
		$ref: '#/components/schemas/LdContext'
		CsourceRegistration:
		required: true
		content:
		@@ -3125,7 +3155,7 @@ components:
		- type: object
		EntityFragment:
		description: \|
		5.2.4 NGSI-LD Entity
		Fragment of NGSI-LD Entity (see 5.4).
		type: object
		properties:
		id:
		@@ -3157,13 +3187,6 @@ components:
		$ref: '#/components/schemas/GeoProperty'
		operationSpace:
		$ref: '#/components/schemas/GeoProperty'
		# Clause 5.2.2 Common members
		createdAt:
		$ref: '#/components/schemas/CreatedAt'
		modifiedAt:
		$ref: '#/components/schemas/ModifiedAt'
		deletedAt:
		$ref: '#/components/schemas/DeletedAt'
		additionalProperties:
		oneOf:
		- $ref: '#/components/schemas/Property'
		@@ -3183,14 +3206,25 @@ components:
		items:
		$ref: '#/components/schemas/LanguageProperty'
		Entity:
		description: \|
		5.2.4 NGSI-LD Entity.
		allOf:
		- $ref: '#/components/schemas/EntityFragment'
		- type: object
		properties:
		# Clause 5.2.2 Common members. System-generated.
		createdAt:
		$ref: '#/components/schemas/CreatedAt'
		modifiedAt:
		$ref: '#/components/schemas/ModifiedAt'
		deletedAt:
		$ref: '#/components/schemas/DeletedAt'
		- required:
		- id
		- type
		Property:
		PropertyFragment:
		description: \|
		5.2.5 NGSI-LD Property.
		Fragment of NGSI-LD Property (see 5.4).
		type: object
		properties:
		type:
		@@ -3222,13 +3256,6 @@ components:
		It allows identifying a set or group of property values.
		type: string
		format: uri
		# Clause 5.2.2 Common members
		createdAt:
		$ref: '#/components/schemas/CreatedAt'
		modifiedAt:
		$ref: '#/components/schemas/ModifiedAt'
		deletedAt:
		$ref: '#/components/schemas/DeletedAt'
		additionalProperties:
		oneOf:
		- $ref: '#/components/schemas/Property'
		@@ -3239,12 +3266,26 @@ components:
		- type: array
		items:
		$ref: '#/components/schemas/Relationship'
		Property:
		description: \|
		5.2.5 NGSI-LD Property.
		allOf:
		- $ref: '#/components/schemas/PropertyFragment'
		- type: object
		properties:
		# Clause 5.2.2 Common members. System-generated
		createdAt:
		$ref: '#/components/schemas/CreatedAt'
		modifiedAt:
		$ref: '#/components/schemas/ModifiedAt'
		deletedAt:
		$ref: '#/components/schemas/DeletedAt'
		required:
		- type
		- value
		Relationship:
		RelationshipFragment:
		description: \|
		5.2.6 NGSI-LD Relationship.
		Fragment of NGSI-LD Relationship (see 5.4).
		properties:
		type:
		description: \|
		@@ -3264,13 +3305,6 @@ components:
		It allows identifying a set or group of target relationship objects.
		type: string
		format: uri
		# Clause 5.2.2 Common members
		createdAt:
		$ref: '#/components/schemas/CreatedAt'
		modifiedAt:
		$ref: '#/components/schemas/ModifiedAt'
		deletedAt:
		$ref: '#/components/schemas/DeletedAt'
		additionalProperties:
		oneOf:
		- $ref: '#/components/schemas/Property'
		@@ -3281,12 +3315,26 @@ components:
		- type: array
		items:
		$ref: '#/components/schemas/Relationship'
		Relationship:
		description: \|
		5.2.6 NGSI-LD Relationship.
		allOf:
		- $ref: '#/components/schemas/RelationshipFragment'
		- type: object
		properties:
		# Clause 5.2.2 Common members. System-generated
		createdAt:
		$ref: '#/components/schemas/CreatedAt'
		modifiedAt:
		$ref: '#/components/schemas/ModifiedAt'
		deletedAt:
		$ref: '#/components/schemas/DeletedAt'
		required:
		- type
		- object
		GeoProperty:
		GeoPropertyFragment:
		description: \|
		5.2.7 NGSI-LD GeoProperty.
		Fragment of NGSI-LD GeoProperty (see 5.4).
		type: object
		properties:
		type:
		@@ -3314,6 +3362,20 @@ components:
		- type: array
		items:
		$ref: '#/components/schemas/Relationship'
		GeoProperty:
		description: \|
		5.2.7 NGSI-LD GeoProperty.
		allOf:
		- $ref: '#/components/schemas/GeoPropertyFragment'
		- type: object
		properties:
		# Clause 5.2.2 Common members. System-generated
		createdAt:
		$ref: '#/components/schemas/CreatedAt'
		modifiedAt:
		$ref: '#/components/schemas/ModifiedAt'
		deletedAt:
		$ref: '#/components/schemas/DeletedAt'
		required:
		- type
		- value
		@@ -3590,6 +3652,8 @@ components:
		The notification triggers listed indicate what kind of changes shall trigger a notification.
		If not present, the default is the combination attributeCreated and attributeUpdated.
		entityUpdated is equivalent to the combination attributeCreated, attributeUpdated and attributeDeleted.
		type: array
		items:
		type: string
		enum:
		- entityCreated
		@@ -3598,6 +3662,9 @@ components:
		- attributeCreated
		- attributeUpdated
		- attributeDeleted
		default:
		- attributeCreated
		- attributeUpdated
		q:
		description: \|
		Query that shall be met by subscribed entities in order to trigger the notification.
		@@ -3640,21 +3707,6 @@ components:
		description: \|
		Language filter to be applied to the query (clause 4.15).
		type: string
		status:
		description: \|
		Read-only. Provided by the system when querying the details of a subscription.
		type: string
		enum:
		- active
		- paused
		- expired
		# Clause 5.2.2 Common members
		createdAt:
		$ref: '#/components/schemas/CreatedAt'
		modifiedAt:
		$ref: '#/components/schemas/ModifiedAt'
		deletedAt:
		$ref: '#/components/schemas/DeletedAt'
		SubscriptionFragment.Periodic:
		allOf:
		- $ref: '#/components/schemas/SubscriptionFragment.Core'
		@@ -3685,12 +3737,59 @@ components:
		oneOf:
		- $ref: '#/components/schemas/SubscriptionFragment.Periodic'
		- $ref: '#/components/schemas/SubscriptionFragment.OnChange'
		Subscription:

		Subscription.Periodic:
		allOf:
		- $ref: '#/components/schemas/SubscriptionFragment'
		- $ref: '#/components/schemas/SubscriptionFragment.Periodic'
		- type: object
		properties:
		# Clause 5.2.2 Common members. System-generated.
		createdAt:
		$ref: '#/components/schemas/CreatedAt'
		modifiedAt:
		$ref: '#/components/schemas/ModifiedAt'
		deletedAt:
		$ref: '#/components/schemas/DeletedAt'
		status:
		description: \|
		Read-only. Provided by the system when querying the details of a subscription.
		type: string
		enum:
		- active
		- paused
		- expired
		- required:
		- type
		- notification
		- entities
		- timeInterval
		Subscription.OnChange:
		allOf:
		- $ref: '#/components/schemas/SubscriptionFragment.OnChange'
		- type: object
		properties:
		# Clause 5.2.2 Common members. System-generated.
		createdAt:
		$ref: '#/components/schemas/CreatedAt'
		modifiedAt:
		$ref: '#/components/schemas/ModifiedAt'
		deletedAt:
		$ref: '#/components/schemas/DeletedAt'
		status:
		description: \|
		Read-only. Provided by the system when querying the details of a subscription.
		type: string
		enum:
		- active
		- paused
		- expired
		- required:
		- type
		- notification
		Subscription:
		oneOf:
		- $ref: '#/components/schemas/Subscription.Periodic'
		- $ref: '#/components/schemas/Subscription.OnChange'
		GeoQuery:
		description: \|
		5.2.13 represents a geoquery used for Subscriptions.
		@@ -4383,10 +4482,9 @@ components:
		$ref: '#/components/schemas/LanguageProperty'
		required:
		- type
		LanguageProperty:
		LanguagePropertyFragment:
		description: \|
		This type represents the data needed to define a LanguageProperty as mandated by clause 4.5.18.
		Note that in case of concise representation, the type can be omitted (see clause 4.5.18.3).
		Fragment of NGSI-LD LanguageProperty (see 5.4).
		type: object
		properties:
		type:
		@@ -4420,6 +4518,23 @@ components:
		- type: array
		items:
		$ref: '#/components/schemas/Relationship'
		LanguageProperty:
		description: \|
		5.2.32 NGSI-LD LanguageProperty.

		This type represents the data needed to define a LanguageProperty as mandated by clause 4.5.18.
		Note that in case of concise representation, the type can be omitted (see clause 4.5.18.3).
		allOf:
		- $ref: '#/components/schemas/LanguagePropertyFragment'
		- type: object
		properties:
		# Clause 5.2.2 Common members. System-generated
		createdAt:
		$ref: '#/components/schemas/CreatedAt'
		modifiedAt:
		$ref: '#/components/schemas/ModifiedAt'
		deletedAt:
		$ref: '#/components/schemas/DeletedAt'
		required:
		- type
		- languageMap