restructure (bcb3218d) · Commits · CIM - Context Information Management / NGSI-LD API

README.md

+4 −3

Original line number	Original line	Diff line number	Diff line
	@@ -10,7 +10,7 @@ This repository contains OpenAPI descriptions for the NGSI-LD interface defined

	To get an account on ETSI Forge and to learn how to contribute visit the [Forge Getting started wiki](https://forge.etsi.org/wiki/index.php/Get_started).		To get an account on ETSI Forge and to learn how to contribute visit the [Forge Getting started wiki](https://forge.etsi.org/wiki/index.php/Get_started).

	More info @ [CONTIBUTE](./CONTRIBUTE.md)		More info @ [CONTRIBUTE](./CONTRIBUTE.md)

	Change requests are managed using [Gerrit](https://forge.etsi.org/gerrit).		Change requests are managed using [Gerrit](https://forge.etsi.org/gerrit).

	@@ -22,12 +22,13 @@ it replaces all paths to the master branch inside [spec](spec) and [schema](sche
	references are resolved with 'https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master' and therefore changes will not be present locally.		references are resolved with 'https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master' and therefore changes will not be present locally.

	With the local file-server still running, you can build the bundled api via:		With the local file-server still running, you can build the bundled api via:
			TODO: change to openapi-cli image -> https://github.com/Redocly/openapi-cli/pull/247/files
	```		```
	docker run --network host -it -v ${PWD}/:/data broothie/redoc-cli bundle spec/updated/ngsi-ld-spec-open-api.json -o spec/updated/full_api.json		docker run --network host -it -v ${PWD}/:/data broothie/redoc-cli bundle spec/updated/ngsi-ld-spec-open-api.json -o spec/updated/generated/full_api.json
	```		```
	And validate it with:		And validate it with:
	```		```
	docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/full_api.json		docker run --network host --rm -v ${PWD}/:/local openapitools/openapi-generator-cli validate -i /local/spec/updated/generated/full_api.json
	```		```

	When editing is finished, hit the enter button on your local dev env and push.		When editing is finished, hit the enter button on your local dev env and push.

schema/BatchOperationResult.json

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -10,7 +10,7 @@
	"format": "uri"		"format": "uri"
	},		},
	"error": {		"error": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"		"$ref": "http://localhost:8090/schema/common.json#/definitions/ProblemDetails"
	}		}
	}		}
	},		},

schema/Entity.json

+14 −14

Original line number	Original line	Diff line number	Diff line
	@@ -27,13 +27,13 @@
	]		]
	},		},
	"observedAt": {		"observedAt": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt"		"$ref": "http://localhost:8090/schema/common.json#/definitions/observedAt"
	},		},
	"createdAt": {		"createdAt": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt"		"$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt"
	},		},
	"modifiedAt": {		"modifiedAt": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt"		"$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt"
	},		},
	"datasetId": {		"datasetId": {
	"$ref": "#/definitions/datasetId"		"$ref": "#/definitions/datasetId"
	@@ -69,13 +69,13 @@
	"format": "uri"		"format": "uri"
	},		},
	"observedAt": {		"observedAt": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt"		"$ref": "http://localhost:8090/schema/common.json#/definitions/observedAt"
	},		},
	"createdAt": {		"createdAt": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt"		"$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt"
	},		},
	"modifiedAt": {		"modifiedAt": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt"		"$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt"
	},		},
	"datasetId": {		"datasetId": {
	"$ref": "#/definitions/datasetId"		"$ref": "#/definitions/datasetId"
	@@ -107,16 +107,16 @@
	"enum": ["GeoProperty"]		"enum": ["GeoProperty"]
	},		},
	"value": {		"value": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/Geometry"		"$ref": "http://localhost:8090/schema/Geometry.json#/definitions/Geometry"
	},		},
	"observedAt": {		"observedAt": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/observedAt"		"$ref": "http://localhost:8090/schema/common.json#/definitions/observedAt"
	},		},
	"createdAt": {		"createdAt": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt"		"$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt"
	},		},
	"modifiedAt": {		"modifiedAt": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt"		"$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt"
	},		},
	"datasetId": {		"datasetId": {
	"$ref": "#/definitions/datasetId"		"$ref": "#/definitions/datasetId"
	@@ -144,7 +144,7 @@
	"type": "object",		"type": "object",
	"properties": {		"properties": {
	"@context": {		"@context": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/LdContext"		"$ref": "http://localhost:8090/schema/common.json#/definitions/LdContext"
	},		},
	"location": {		"location": {
	"$ref": "#/definitions/GeoProperty"		"$ref": "#/definitions/GeoProperty"
	@@ -160,13 +160,13 @@
	"format": "uri"		"format": "uri"
	},		},
	"type": {		"type": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/Name"		"$ref": "http://localhost:8090/schema/common.json#/definitions/Name"
	},		},
	"createdAt": {		"createdAt": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/createdAt"		"$ref": "http://localhost:8090/schema/common.json#/definitions/createdAt"
	},		},
	"modifiedAt": {		"modifiedAt": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/modifiedAt"		"$ref": "http://localhost:8090/schema/common.json#/definitions/modifiedAt"
	}		}
	},		},
	"additionalProperties": {		"additionalProperties": {

schema/EntityList.json

+1 −1

Original line number	Original line	Diff line number	Diff line
	@@ -5,7 +5,7 @@
	"EntityList": {		"EntityList": {
	"type": "array",		"type": "array",
	"items": {		"items": {
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#/definitions/Entity"		"$ref": "http://localhost:8090/schema/Entity.json#/definitions/Entity"
	}		}
	}		}
	},		},

schema/common.json

+4 −4

Original line number	Original line	Diff line number	Diff line
	@@ -128,16 +128,16 @@
	"coordinates": {		"coordinates": {
	"oneOf": [		"oneOf": [
	{		{
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/position"		"$ref": "http://localhost:8090/schema/Geometry.json#/definitions/position"
	},		},
	{		{
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/positionArray"		"$ref": "http://localhost:8090/schema/Geometry.json#/definitions/positionArray"
	},		},
	{		{
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/lineString"		"$ref": "http://localhost:8090/schema/Geometry.json#/definitions/lineString"
	},		},
	{		{
	"$ref": "https://forge.etsi.org/rep/NGSI-LD/NGSI-LD/raw/master/schema/Geometry.json#/definitions/polygon"		"$ref": "http://localhost:8090/schema/Geometry.json#/definitions/polygon"
	}		}
	]		]
	},		},

Admin message