Restoring entities-spec (f4b91e56) · Commits · CIM - Context Information Management / NGSI-LD API

spec/updated/entities-spec.json

+179 −123

Original line number	Original line	Diff line number	Diff line
	{		{
	"openapi": "3.0.1",		"openapi": "3.0.1",
	"info": {		"info": {
	"title": "NGSI-LD Entity Operations",		"title": "NGSI-LD Entities",
	"version": "0.1"		"version": "latest"
	},		},
	"components": {},		"components": {
	"paths": {		"parameters": {
	"/entityOperations/create": {		"id": {
	"post": {		"name": "id",
	"description": "Batch Entity creation",		"description": "Comma separated list of URIs to be retrieved",
	"operationId": "batchEntityCreation",		"in": "query",
	"requestBody": {		"required": false,
	"required": true,
	"content": {
	"application/json;application/ld+json": {
	"schema": {		"schema": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList"		"type": "string",
	}		"format": "uri"
	}
	}		}
	},		},
	"responses": {		"type": {
	"200": {		"name": "type",
	"description": "Success",		"description": "Comma separated list of Entity type names to be retrieved",
	"content": {		"in": "query",
	"application/json;application/ld+json": {		"required": false,
	"schema": {		"schema": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"		"type": "string",
	}		"minLength": 1
	}		}
			},
			"idPattern": {
			"name": "idPattern",
			"description": "Regular expression that must be matched by Entity ids",
			"in": "query",
			"required": false,
			"schema": {
			"type": "string",
			"format": "regexp"
	}		}
	},		},
	"400": {		"attrs": {
	"description": "Bad request",		"name": "attrs",
	"content": {		"description": "Comma separated list of attribute names (properties or relationships) to be retrieved",
	"application/json;application/ld+json": {		"in": "query",
			"required": false,
	"schema": {		"schema": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"		"type": "string",
			"minLength": 1
	}		}
			},
			"q": {
			"name": "q",
			"description": "Query",
			"in": "query",
			"required": false,
			"schema": {
			"type": "string",
			"minLength": 1
	}		}
			},
			"georel": {
			"name": "georel",
			"description": "Geo-relationship",
			"in": "query",
			"required": false,
			"schema": {
			"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/georel"
	}		}
			},
			"geometry": {
			"name": "geometry",
			"description": "Geometry",
			"in": "query",
			"required": false,
			"schema": {
			"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/geometry"
	}		}
			},
			"coordinates": {
			"name": "coordinates",
			"description": "Coordinates serialized as a string",
			"in": "query",
			"required": false,
			"schema": {
			"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/coordinates"
	}		}
			},
			"geoproperty": {
			"name": "geoproperty",
			"description": "The name of the property that contains the geo-spatial data that will be used to resolve the geoquery",
			"in": "query",
			"required": false,
			"schema": {
			"type": "string",
			"minLength": 1
	}		}
	},		},
	"/entityOperations/update": {		"csf": {
	"post": {		"name": "csf",
	"description": "Batch Entity update",		"description": "Context Source Filter",
	"operationId": "batchEntityUpdate",
	"parameters": [
	{
	"name": "options",
	"in": "query",		"in": "query",
	"required": false,		"required": false,
	"schema": {		"schema": {
	"type": "string",		"type": "string",
	"enum": [		"minLength": 1
	"noOverwrite"
	]
	}		}
			},
			"limit": {
			"name": "limit",
			"description": "Pagination limit",
			"in": "query",
			"required": false,
			"schema": {
			"type": "integer",
			"minimum": 1
	}		}
	],		},
	"requestBody": {		"options":{
	"required": true,		"name": "options",
	"content": {		"description": "Options dictionary",
	"application/json;application/ld+json": {		"in": "query",
			"required": false,
	"schema": {		"schema": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList"		"type": "string",
			"enum": ["keyValues", "sysAttrs"]
	}		}
	}		}
	}		}
	},		},
			"paths": {
			"/entities/": {
			"get": {
			"description": "Retrieve a set of entities which matches a specific query from an NGSI-LD system",
			"operationId": "queryEntities",
			"parameters": [
			{
			"$ref": "#/components/parameters/id"
			},
			{
			"$ref": "#/components/parameters/idPattern"
			},
			{
			"$ref": "#/components/parameters/type"
			},
			{
			"$ref": "#/components/parameters/attrs"
			},
			{
			"$ref": "#/components/parameters/q"
			},
			{
			"$ref": "#/components/parameters/georel"
			},
			{
			"$ref": "#/components/parameters/geometry"
			},
			{
			"$ref": "#/components/parameters/coordinates"
			},
			{
			"$ref": "#/components/parameters/geoproperty"
			},
			{
			"$ref": "#/components/parameters/csf"
			},
			{
			"$ref": "#/components/parameters/limit"
			},
			{
			"$ref": "#/components/parameters/options"
			}
			],
	"responses": {		"responses": {
	"200": {		"200": {
	"description": "Success",		"description": "OK",
	"content": {		"content": {
	"application/json;application/ld+json": {		"application/json;application/ld+json": {
	"schema": {		"schema": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"		"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList"
			},
			"examples": {
			"simple": {
			"externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/EntityList-example.json"
			}
	}		}
	}		}
	}		}
	@@ -93,46 +195,23 @@
	}		}
	}		}
	}		}
	}
	},		},
	"/entityOperations/upsert": {
	"post": {		"post": {
	"description": "Batch Entity upsert",		"description": "Create a new Entity within an NGSI-LD system",
	"operationId": "batchEntityUpsert",		"operationId": "createEntity",
	"parameters": [
	{
	"name": "options",
	"in": "query",
	"required": false,
	"schema": {
	"type": "string",
	"enum": [
	"replace",
	"update"
	]
	}
	}
	],
	"requestBody": {		"requestBody": {
	"required": true,		"required": true,
	"content": {		"content": {
	"application/json;application/ld+json": {		"application/json;application/ld+json": {
	"schema": {		"schema": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#/definitions/EntityList"		"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity"
	}		}
	}		}
	}		}
	},		},
	"responses": {		"responses": {
	"200": {		"201": {
	"description": "Success",		"description": "Created. Contains the resource URI of the created Entity"
	"content": {
	"application/json;application/ld+json": {
	"schema": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"
	}
	}
	}
	},		},
	"400": {		"400": {
	"description": "Bad request",		"description": "Bad request",
	@@ -143,42 +222,19 @@
	}		}
	}		}
	}		}
	}
	}
	}
	},		},
	"/entityOperations/delete": {		"409": {
	"post": {		"description": "Already exists",
	"description": "Batch Entity delete",
	"operationId": "batchEntityDelete",
	"requestBody": {
	"required": true,
	"content": {
	"application/json;application/ld+json": {
	"schema": {
	"type": "array",
	"items": {
	"type": "string",
	"format": "uri"
	},
	"minItems": 1
	}
	}
	}
	},
	"responses": {
	"200": {
	"description": "Success",
	"content": {		"content": {
	"application/json;application/ld+json": {		"application/json;application/ld+json": {
	"schema": {		"schema": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/BatchOperationResult.json#/definitions/BatchOperationResult"		"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
	}		}
	}		}
	}		}
	},		},
	"400": {		"422": {
	"description": "Bad request",		"description": "Unprocessable Entity",
	"content": {		"content": {
	"application/json;application/ld+json": {		"application/json;application/ld+json": {
	"schema": {		"schema": {

spec/updated/ngsi-ld-spec-open-api_test.json

+5 −5

Original line number	Original line	Diff line number	Diff line
	@@ -90,19 +90,19 @@
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fdelete"		"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/entity-operations-spec.json#/paths/%2FentityOperations%2Fdelete"
	},		},
	"/temporal/entities/": {		"/temporal/entities/": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal-entities-spec.json#/paths/%2Ftemporal%2Fentities%2F"		"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entities-spec.json#/paths/%2Ftemporal%2Fentities%2F"
	},		},
	"/temporal/entities/{entityId}": {		"/temporal/entities/{entityId}": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal-entity-by-id-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D"		"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-by-id-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D"
	},		},
	"/temporal/entities/{entityId}/attrs/": {		"/temporal/entities/{entityId}/attrs/": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F"		"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F"
	},		},
	"/temporal/entities/{entityId}/attrs/{attrId}": {		"/temporal/entities/{entityId}/attrs/{attrId}": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D"		"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D"
	},		},
	"/temporal/entities/{entityId}/attrs/{attrId}/{instanceId}": {		"/temporal/entities/{entityId}/attrs/{attrId}/{instanceId}": {
	"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D%7BinstanceId%7D"		"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/spec/updated/temporal/temporal-entity-attrs-spec.json#/paths/%2Ftemporal%2Fentities%2F%7BentityId%7D%2Fattrs%2F%7BattrId%7D%7BinstanceId%7D"
	}		}
	}		}
	}		}