Skip to content

Commit be8f0db

Browse files
Joudsijmcanterafonseca
authored andcommitted
first modification for the specs document examples format (FIWARE#304)
1 parent a30ed44 commit be8f0db

File tree

1 file changed

+36
-29
lines changed
  • specs/Environment/AirQualityObserved/doc

1 file changed

+36
-29
lines changed

specs/Environment/AirQualityObserved/doc/spec.md

+36-29
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,10 @@ Below is the description of the attribute to be used for option A/.
134134
a [FIWARE NGSI version 2](http://fiware.github.io/specifications/ngsiv2/stable) API implementation, you need to use the `keyValues`
135135
mode (`options=keyValues`).
136136

137-
## Examples of use 1 (Normalized Format)
137+
## Examples
138+
### Normalized Example
139+
140+
Normalized NGSI response
138141

139142
```json
140143
{
@@ -237,40 +240,44 @@ mode (`options=keyValues`).
237240
}
238241
}
239242
```
240-
241-
## Examples of use 2 (?options=keyValues simplified representation for data consumers)
242243

243-
{
244-
"id": "Madrid-AmbientObserved-28079004-2016-03-15T11:00:00",
245-
"type": "AirQualityObserved",
246-
"address": {
244+
### key-value pairs Example
245+
246+
Sample uses simplified representation for data consumers `?options=keyValues`
247+
248+
```json
249+
{
250+
"id": "Madrid-AmbientObserved-28079004-2016-03-15T11:00:00",
251+
"type": "AirQualityObserved",
252+
"address": {
247253
"addressCountry": "ES",
248254
"addressLocality": "Madrid",
249255
"streetAddress": "Plaza de España"
250-
},
251-
"dateObserved": "2016-03-15T11:00:00/2016-03-15T12:00:00",
252-
"location": {
256+
},
257+
"dateObserved": "2016-03-15T11:00:00/2016-03-15T12:00:00",
258+
"location": {
253259
"type": "Point",
254260
"coordinates": [-3.712247222222222, 40.423852777777775]
255-
},
256-
"source": "http://datos.madrid.es",
257-
"precipitation": 0,
258-
"relativeHumidity": 0.54,
259-
"temperature": 12.2,
260-
"windDirection": 186,
261-
"windSpeed": 0.64,
262-
"airQualityLevel": "moderate",
263-
"reliability": 0.9,
264-
"CO": 500,
265-
"NO": 45,
266-
"NO2": 69,
267-
"NOx": 139,
268-
"SO2": 11,
269-
"CO_Level": "good",
270-
"NO_Level": "moderate",
271-
"refPointOfInterest": "28079004-Pza. de España"
272-
}
273-
261+
},
262+
"source": "http://datos.madrid.es",
263+
"precipitation": 0,
264+
"relativeHumidity": 0.54,
265+
"temperature": 12.2,
266+
"windDirection": 186,
267+
"windSpeed": 0.64,
268+
"airQualityLevel": "moderate",
269+
"reliability": 0.9,
270+
"CO": 500,
271+
"NO": 45,
272+
"NO2": 69,
273+
"NOx": 139,
274+
"SO2": 11,
275+
"CO_Level": "good",
276+
"NO_Level": "moderate",
277+
"refPointOfInterest": "28079004-Pza. de España"
278+
}
279+
```
280+
274281
## Use it with a real service
275282

276283
To get access to a public instance offering air quality observed data please have a look at the [GSMA's API Directory](http://apidirectory.connectedliving.gsma.com/api/air-quality-spain).

0 commit comments

Comments
 (0)