Skip to content

Commit 3cd38e0

Browse files
updated model.yaml - support subproperties
1 parent 80ff16a commit 3cd38e0

1 file changed

Lines changed: 398 additions & 0 deletions

File tree

CarbonFootprint/model.yaml

Lines changed: 398 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,398 @@
1+
CarbonFootprint:
2+
description: Data model to represent the carbon footprint in CO2 equivalents.
3+
properties:
4+
CO2eq:
5+
description: Amount of emissions in tons of CO2 equivalent
6+
minimum: 0
7+
type: number
8+
x-ngsi:
9+
model: https://schema.org/Number
10+
type: Property
11+
address:
12+
description: The mailing address
13+
properties:
14+
addressCountry:
15+
description: The country. For example, Spain
16+
type: string
17+
x-ngsi:
18+
model: https://schema.org/addressCountry
19+
type: Property
20+
addressLocality:
21+
description: The locality in which the street address is, and which is in the region
22+
type: string
23+
x-ngsi:
24+
model: https://schema.org/addressLocality
25+
type: Property
26+
addressRegion:
27+
description: The region in which the locality is, and which is in the country
28+
type: string
29+
x-ngsi:
30+
model: https://schema.org/addressRegion
31+
type: Property
32+
district:
33+
description: A district is a type of administrative division that, in some countries, is managed by the local government
34+
type: string
35+
x-ngsi:
36+
type: Property
37+
postOfficeBoxNumber:
38+
description: The post office box number for PO box addresses. For example, 03578
39+
type: string
40+
x-ngsi:
41+
model: https://schema.org/postOfficeBoxNumber
42+
type: Property
43+
postalCode:
44+
description: The postal code. For example, 24004
45+
type: string
46+
x-ngsi:
47+
model: https://schema.org/https://schema.org/postalCode
48+
type: Property
49+
streetAddress:
50+
description: The street address
51+
type: string
52+
x-ngsi:
53+
model: https://schema.org/streetAddress
54+
type: Property
55+
streetNr:
56+
description: Number identifying a specific property on a public street
57+
type: string
58+
x-ngsi:
59+
type: Property
60+
type: object
61+
x-ngsi:
62+
model: https://schema.org/address
63+
type: Property
64+
alternateName:
65+
description: An alternative name for this item
66+
type: string
67+
x-ngsi:
68+
type: Property
69+
areaServed:
70+
description: The geographic area where a service or offered item is provided
71+
type: string
72+
x-ngsi:
73+
model: https://schema.org/Text
74+
type: Property
75+
dataProvider:
76+
description: A sequence of characters identifying the provider of the harmonised data entity
77+
type: string
78+
x-ngsi:
79+
type: Property
80+
dateCreated:
81+
description: Entity creation timestamp. This will usually be allocated by the storage platform
82+
format: date-time
83+
type: string
84+
x-ngsi:
85+
type: Property
86+
dateModified:
87+
description: Timestamp of the last modification of the entity. This will usually be allocated by the storage platform
88+
format: date-time
89+
type: string
90+
x-ngsi:
91+
type: Property
92+
description:
93+
description: A description of this item
94+
type: string
95+
x-ngsi:
96+
type: Property
97+
emissionDate:
98+
description: Date and time of the measurement
99+
format: date-time
100+
type: string
101+
x-ngsi:
102+
model: https://schema.org/Text
103+
type: Property
104+
emissionSource:
105+
description: Source of emissions (e.g., Transport, Energy, Industry)
106+
type: string
107+
x-ngsi:
108+
type: Property
109+
id:
110+
anyOf:
111+
- description: Identifier format of any NGSI entity
112+
maxLength: 256
113+
minLength: 1
114+
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
115+
type: string
116+
x-ngsi:
117+
type: Property
118+
- description: Identifier format of any NGSI entity
119+
format: uri
120+
type: string
121+
x-ngsi:
122+
type: Property
123+
description: Unique identifier of the entity
124+
x-ngsi:
125+
type: Relationship
126+
location:
127+
description: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon
128+
oneOf:
129+
- description: Geojson reference to the item. Point
130+
properties:
131+
bbox:
132+
description: BBox of the Point
133+
items:
134+
type: number
135+
minItems: 4
136+
type: array
137+
x-ngsi:
138+
type: Property
139+
coordinates:
140+
description: Coordinates of the Point
141+
items:
142+
type: number
143+
minItems: 2
144+
type: array
145+
x-ngsi:
146+
type: Property
147+
type:
148+
enum:
149+
- Point
150+
type: string
151+
required:
152+
- type
153+
- coordinates
154+
title: GeoJSON Point
155+
type: object
156+
x-ngsi:
157+
type: GeoProperty
158+
- description: Geojson reference to the item. LineString
159+
properties:
160+
bbox:
161+
description: BBox coordinates of the LineString
162+
items:
163+
type: number
164+
minItems: 4
165+
type: array
166+
x-ngsi:
167+
type: Property
168+
coordinates:
169+
description: Coordinates of the LineString
170+
items:
171+
items:
172+
type: number
173+
minItems: 2
174+
type: array
175+
minItems: 2
176+
type: array
177+
x-ngsi:
178+
type: Property
179+
type:
180+
enum:
181+
- LineString
182+
type: string
183+
required:
184+
- type
185+
- coordinates
186+
title: GeoJSON LineString
187+
type: object
188+
x-ngsi:
189+
type: GeoProperty
190+
- description: Geojson reference to the item. Polygon
191+
properties:
192+
bbox:
193+
description: BBox coordinates of the Polygon
194+
items:
195+
type: number
196+
minItems: 4
197+
type: array
198+
x-ngsi:
199+
type: Property
200+
coordinates:
201+
description: Coordinates of the Polygon
202+
items:
203+
items:
204+
items:
205+
type: number
206+
minItems: 2
207+
type: array
208+
minItems: 4
209+
type: array
210+
type: array
211+
x-ngsi:
212+
type: Property
213+
type:
214+
enum:
215+
- Polygon
216+
type: string
217+
required:
218+
- type
219+
- coordinates
220+
title: GeoJSON Polygon
221+
type: object
222+
x-ngsi:
223+
type: GeoProperty
224+
- description: Geojson reference to the item. MultiPoint
225+
properties:
226+
bbox:
227+
description: BBox coordinates of the LineString
228+
items:
229+
type: number
230+
minItems: 4
231+
type: array
232+
x-ngsi:
233+
type: Property
234+
coordinates:
235+
description: Coordinates of the MulitPoint
236+
items:
237+
items:
238+
type: number
239+
minItems: 2
240+
type: array
241+
type: array
242+
x-ngsi:
243+
type: Property
244+
type:
245+
enum:
246+
- MultiPoint
247+
type: string
248+
required:
249+
- type
250+
- coordinates
251+
title: GeoJSON MultiPoint
252+
type: object
253+
x-ngsi:
254+
type: GeoProperty
255+
- description: Geojson reference to the item. MultiLineString
256+
properties:
257+
bbox:
258+
description: BBox coordinates of the LineString
259+
items:
260+
type: number
261+
minItems: 4
262+
type: array
263+
x-ngsi:
264+
type: Property
265+
coordinates:
266+
description: Coordinates of the MultiLineString
267+
items:
268+
items:
269+
items:
270+
type: number
271+
minItems: 2
272+
type: array
273+
minItems: 2
274+
type: array
275+
type: array
276+
x-ngsi:
277+
type: Property
278+
type:
279+
enum:
280+
- MultiLineString
281+
type: string
282+
required:
283+
- type
284+
- coordinates
285+
title: GeoJSON MultiLineString
286+
type: object
287+
x-ngsi:
288+
type: GeoProperty
289+
- description: Geojson reference to the item. MultiLineString
290+
properties:
291+
bbox:
292+
items:
293+
type: number
294+
minItems: 4
295+
type: array
296+
coordinates:
297+
description: Coordinates of the MultiPolygon
298+
items:
299+
items:
300+
items:
301+
items:
302+
type: number
303+
minItems: 2
304+
type: array
305+
minItems: 4
306+
type: array
307+
type: array
308+
type: array
309+
x-ngsi:
310+
type: Property
311+
type:
312+
enum:
313+
- MultiPolygon
314+
type: string
315+
required:
316+
- type
317+
- coordinates
318+
title: GeoJSON MultiPolygon
319+
type: object
320+
x-ngsi:
321+
type: GeoProperty
322+
x-ngsi:
323+
type: GeoProperty
324+
name:
325+
description: The name of this item
326+
type: string
327+
x-ngsi:
328+
type: Property
329+
owner:
330+
description: A List containing a JSON encoded sequence of characters referencing the unique Ids of the owner(s)
331+
items:
332+
anyOf:
333+
- description: Identifier format of any NGSI entity
334+
maxLength: 256
335+
minLength: 1
336+
pattern: ^[\w\-\.\{\}\$\+\*\[\]`|~^@!,:\\]+$
337+
type: string
338+
x-ngsi:
339+
type: Property
340+
- description: Identifier format of any NGSI entity
341+
format: uri
342+
type: string
343+
x-ngsi:
344+
type: Property
345+
description: Unique identifier of the entity
346+
x-ngsi:
347+
type: Relationship
348+
type: array
349+
x-ngsi:
350+
type: Property
351+
relatedSource:
352+
description: Reference to the data source or related entity
353+
format: uri
354+
type: string
355+
x-ngsi:
356+
type: Relationship
357+
seeAlso:
358+
description: list of uri pointing to additional resources about the item
359+
oneOf:
360+
- items:
361+
format: uri
362+
type: string
363+
minItems: 1
364+
type: array
365+
- format: uri
366+
type: string
367+
x-ngsi:
368+
type: Property
369+
source:
370+
description: A sequence of characters giving the original source of the entity data as a URL. Recommended to be the fully qualified domain name of the source provider, or the URL to the source object
371+
type: string
372+
x-ngsi:
373+
type: Property
374+
tags:
375+
description: Tags associated with the carbon footprint calculation.
376+
items:
377+
description: Tag name
378+
type: string
379+
x-ngsi:
380+
type: Property
381+
type: array
382+
x-ngsi:
383+
type: Property
384+
type:
385+
description: NGSI Entity type. It must be 'CarbonFootprint'
386+
type: string
387+
x-ngsi:
388+
type: Property
389+
required:
390+
- id
391+
- type
392+
type: object
393+
x-derived-from: ''
394+
x-disclaimer: Redistribution and use in source and binary forms, with or without modification, are permitted provided that the license conditions are met. Copyleft (c) 2025 Contributors to Smart Data Models Program
395+
x-license-url: https://github.com/smart-data-models/dataModel.Environment/blob/master/CarbonFootprint/LICENSE.md
396+
x-model-schema: https://smart-data-models.github.io/Environment/CarbonFootprint/schema.json
397+
x-model-tags: Carbon, Emissions, CO2eq
398+
x-version: 0.0.1

0 commit comments

Comments
 (0)