Use only one tag per operation to improve documentation (dd7a3230) · Commits · CIM - Context Information Management / NGSI-LD API

ngsi-ld-api.yaml

+0 −45

Original line number	Diff line number	Diff line
		@@ -20,7 +20,6 @@ paths:
		/entities:
		post:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Entity creation
		@@ -64,7 +63,6 @@ paths:
		$ref: '#/components/responses/Unprocessable'
		get:
		tags:
		- Core API
		- Context Information Consumption
		summary: \|
		Query entities
		@@ -143,7 +141,6 @@ paths:
		/entities/{entityId}:
		get:
		tags:
		- Core API
		- Context Information Consumption
		summary: \|
		Entity retrieval by id
		@@ -210,7 +207,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		delete:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Entity deletion by id
		@@ -251,7 +247,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		patch:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Entity merge by id.
		@@ -301,7 +296,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		put:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Entity replacement by id.
		@@ -340,7 +334,6 @@ paths:
		/entities/{entityId}/attrs:
		post:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Append attributes to Entity
		@@ -379,7 +372,6 @@ paths:

		patch:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Update attributes of an Entity
		@@ -416,7 +408,6 @@ paths:
		/entities/{entityId}/attrs/{attrId}:
		patch:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Partial Attribute update.
		@@ -454,7 +445,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		delete:
		tags:
		- Core API
		- Context Information Provision
		summary: Attribute delete
		description: 5.6.5 Delete Entity Attribute.
		@@ -486,7 +476,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		put:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Attribute replace.
		@@ -524,7 +513,6 @@ paths:
		/csourceRegistrations:
		post:
		tags:
		- Registry API
		- Context Source Registration
		summary: Csource registration creation
		description: \|
		@@ -561,7 +549,6 @@ paths:
		$ref: '#/components/responses/Unprocessable'
		get:
		tags:
		- Registry API
		- Context Source Discovery
		summary: \|
		Discover Csource registrations
		@@ -639,7 +626,6 @@ paths:
		/csourceRegistrations/{registrationId}:
		get:
		tags:
		- Registry API
		- Context Source Discovery
		summary: Csource registration retrieval by id
		description: \|
		@@ -688,7 +674,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		patch:
		tags:
		- Core API
		- Context Source Registration
		summary: Csource registration update by id
		description: \|
		@@ -722,7 +707,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		delete:
		tags:
		- Core API
		- Context Source Registration
		summary: Csource registration deletion by id
		description: \|
		@@ -752,7 +736,6 @@ paths:
		/subscriptions:
		post:
		tags:
		- Core API
		- Context Information Subscription
		summary: Create Subscription
		description: \|
		@@ -786,7 +769,6 @@ paths:
		$ref: '#/components/responses/Conflict'
		get:
		tags:
		- Core API
		- Context Information Consumption
		summary: Retrieve list of Subscriptions
		description: \|
		@@ -834,7 +816,6 @@ paths:
		/subscriptions/{subscriptionId}:
		get:
		tags:
		- Core API
		- Context Information Consumption
		summary: Subscription retrieval by id
		description: \|
		@@ -883,7 +864,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		patch:
		tags:
		- Core API
		- Context Information Subscription
		summary: Subscription update by id
		description: \|
		@@ -916,7 +896,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		delete:
		tags:
		- Core API
		- Context Information Subscription
		summary: Subscription deletion by id
		description: \|
		@@ -946,7 +925,6 @@ paths:
		/csourceSubscriptions:
		post:
		tags:
		- Registry API
		- Context Source Registration Subscription
		summary: Create subscription to Csource registration.
		description: \|
		@@ -983,7 +961,6 @@ paths:
		$ref: '#/components/responses/Unprocessable'
		get:
		tags:
		- Registry API
		- Context Source Registration Subscription
		summary: \|
		Retrieval of list of subscription to Csource registration.
		@@ -1034,7 +1011,6 @@ paths:
		/csourceSubscriptions/{subscriptionId}:
		get:
		tags:
		- Registry API
		- Context Source Registration Subscription
		summary: Retrieval of list of subscription to Csource registration.
		description: \|
		@@ -1086,7 +1062,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		patch:
		tags:
		- Registry API
		- Context Source Registration Subscription
		summary: Csource registration subscription update by id.
		description: \|
		@@ -1120,7 +1095,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		delete:
		tags:
		- Core API
		- Context Source Registration
		summary: Csource registration subscription deletion by id.
		description: \|
		@@ -1150,7 +1124,6 @@ paths:
		/entityOperations/create:
		post:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Batch Entity creation.
		@@ -1219,7 +1192,6 @@ paths:
		/entityOperations/upsert:
		post:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Batch Entity create or update (upsert).
		@@ -1292,7 +1264,6 @@ paths:
		/entityOperations/update:
		post:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Batch Entity update.
		@@ -1343,7 +1314,6 @@ paths:
		/entityOperations/delete:
		post:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Batch Entity delete.
		@@ -1392,7 +1362,6 @@ paths:
		/entityOperations/query:
		post:
		tags:
		- Core API
		- Context Information Consumption
		summary: Query entities based on POST.
		description: 5.7.2 Query Entity.
		@@ -1436,7 +1405,6 @@ paths:
		/entityOperations/merge:
		post:
		tags:
		- Core API
		- Context Information Provision
		summary: \|
		Batch Entity merge.
		@@ -1487,7 +1455,6 @@ paths:
		/temporal/entities:
		post:
		tags:
		- Temporal API
		- Temporal Context Information Provision
		summary: \|
		Temporal Representation of Entity creation.
		@@ -1530,7 +1497,6 @@ paths:
		$ref: '#/components/responses/Unprocessable'
		get:
		tags:
		- Temporal API
		- Temporal Context Information Consumption
		summary: Query temporal evolution of Entities.
		description: \|
		@@ -1602,7 +1568,6 @@ paths:
		/temporal/entities/{entityId}:
		get:
		tags:
		- Temporal API
		- Temporal Context Information Consumption
		summary: Temporal Representation of Entity retrieval by id
		description: \|
		@@ -1661,7 +1626,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		delete:
		tags:
		- Temporal API
		- Temporal Context Information Provision
		summary: \|
		Temporal Representation of Entity deletion by id.
		@@ -1692,7 +1656,6 @@ paths:
		/temporal/entities/{entityId}/attrs:
		post:
		tags:
		- Temporal API
		- Temporal Context Information Provision
		summary: \|
		Temporal Representation of Entity Attribute instance addition
		@@ -1727,7 +1690,6 @@ paths:
		/temporal/entities/{entityId}/attrs/{attrId}:
		delete:
		tags:
		- Temporal API
		- Temporal Context Information Provision
		summary: \|
		Attribute from Temporal Representation of Entity deletion.
		@@ -1763,7 +1725,6 @@ paths:
		/temporal/entities/{entityId}/attrs/{attrId}/{instanceId}:
		patch:
		tags:
		- Temporal API
		- Temporal Context Information Provision
		summary: \|
		Attribute Instance update.
		@@ -1802,7 +1763,6 @@ paths:
		$ref: '#/components/responses/NotFound'
		delete:
		tags:
		- Temporal API
		- Temporal Context Information Provision
		summary: \|
		Attribute Instance deletion by instance id.
		@@ -1839,7 +1799,6 @@ paths:
		/temporal/entityOperations/query:
		post:
		tags:
		- Temporal API
		- Temporal Context Information Consumption
		summary: Temporal Representation of Entity Query based on POST
		description: \|
		@@ -1887,7 +1846,6 @@ paths:
		/types:
		get:
		tags:
		- Core API
		- Context Information Consumption
		summary: Retrieve available entity types
		description: \|
		@@ -1962,7 +1920,6 @@ paths:
		/types/{type}:
		get:
		tags:
		- Core API
		- Context Information Consumption
		summary: Details about available entity type
		description: \|
		@@ -2012,7 +1969,6 @@ paths:
		/attributes:
		get:
		tags:
		- Core API
		- Context Information Consumption
		summary: Retrieve Available Attributes
		description: \|
		@@ -2083,7 +2039,6 @@ paths:
		/attributes/{attrId}:
		get:
		tags:
		- Core API
		- Context Information Consumption
		summary: Retrieve Available Attribute Information
		description: \|