entities-spec.json 5.64 KB
Newer Older
canterafonsj's avatar
canterafonsj committed
1
{
canterafonsj's avatar
canterafonsj committed
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
	"openapi": "3.0.1",
	"info": {
		"title": "NGSI-LD Entities",
		"version": "latest"
	},
	"components": {
		"parameters": {
			"id": {
				"name": "id",
				"description": "Comma separated list of URIs to be retrieved",
				"in": "query",
				"required": false,
				"schema": {
					"type": "string",
					"format": "uri"
				}
			},
			"type": {
				"name": "type",
				"description": "Comma separated list of Entity type names to be retrieved",
				"in": "query",
				"required": false,
				"schema": {
					"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"
				}
			},
			"attrs": {
				"name": "attrs",
				"description": "Comma separated list of attribute names (properties or relationships) to be retrieved",
				"in": "query",
				"required": false,
				"schema": {
					"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
				}
			},
			"csf": {
				"name": "csf",
				"description": "Context Source Filter",
				"in": "query",
				"required": false,
				"schema": {
					"type": "string",
					"minLength": 1
				}
			},
			"limit": {
			  "name": "limit",
			  "description": "Pagination limit",
			  "in": "query",
			  "required": false,
			  "schema": {
			    "type": "integer",
			    "minimum": 1
			  }
			}
		}
	},
	"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"
					}
				],
				"responses": {
					"200": {
						"description": "OK",
						"content": {
							"application/json;application/ld+json": {
								"schema": {
									"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/EntityList.json#"
								},
								"examples": {
									"simple": {
										"externalValue": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/examples/Entity-example.json"
									}
								}
							}
						}
					},
					"400": {
						"description": "Bad request",
						"content": {
							"application/json;application/ld+json": {
								"schema": {
									"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
								}
							}
						}
					}
				}
			},
			"post": {
				"description": "Create a new Entity within an NGSI-LD system",
				"operationId": "createEntity",
				"requestBody": {
				  "required": true,
				  "content": {
				    "application/json;application/ld+json": {
				      "schema": {
									"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/Entity.json#"
				      },
				    }
				  }
				},
				"responses": {
					"201": {
						"description": "Created. Contains the resource URI of the created Entity"
					},
					"400": {
						"description": "Bad request",
						"content": {
							"application/json;application/ld+json": {
								"schema": {
								"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
								}
							}
						}
					},
					"409": {
						"description": "Already exists",
						"content": {
							"application/json;application/ld+json": {
								"schema": {
									"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
								}
							}
						}
					},
					"422": {
						"description": "Unprocessable Entity",
						"content": {
							"application/json;application/ld+json": {
								"schema": {
									"$ref": "https://forge.etsi.org/gitlab/NGSI-LD/NGSI-LD/raw/master/schema/common.json#/definitions/ProblemDetails"
								}
							}
						}
					}
				}
			}
		}
	}
canterafonsj's avatar
canterafonsj committed
236
}