Skip to content

Commit 9c669bf

Browse files
Update EN-US
1 parent 4b86b0b commit 9c669bf

1 file changed

Lines changed: 55 additions & 19 deletions

File tree

VehicleModel/doc/spec.md

Lines changed: 55 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
<!-- /15-License -->
99
<!-- 20-Description -->
1010
Global description: **This entity models a particular vehicle model, including all properties which are common to multiple vehicle instances belonging to such model.**
11-
version: 0.0.1
11+
version: 0.0.2
1212
<!-- /20-Description -->
1313
<!-- 30-PropertiesList -->
1414

@@ -37,42 +37,42 @@
3737
<details><summary><strong>full yaml details</strong></summary>
3838
```yaml
3939
VehicleModel:
40-
description: 'This entity models a particular vehicle model, including all properties which are common to multiple vehicle instances belonging to such model.'
40+
description: This entity models a particular vehicle model, including all properties which are common to multiple vehicle instances belonging to such model.
4141
properties:
4242
address:
4343
description: The mailing address
4444
properties:
4545
addressCountry:
46-
description: 'The country. For example, Spain'
46+
description: The country. For example, Spain
4747
type: string
4848
x-ngsi:
4949
model: https://schema.org/addressCountry
5050
type: Property
5151
addressLocality:
52-
description: 'The locality in which the street address is, and which is in the region'
52+
description: The locality in which the street address is, and which is in the region
5353
type: string
5454
x-ngsi:
5555
model: https://schema.org/addressLocality
5656
type: Property
5757
addressRegion:
58-
description: 'The region in which the locality is, and which is in the country'
58+
description: The region in which the locality is, and which is in the country
5959
type: string
6060
x-ngsi:
6161
model: https://schema.org/addressRegion
6262
type: Property
6363
district:
64-
description: 'A district is a type of administrative division that, in some countries, is managed by the local government'
64+
description: A district is a type of administrative division that, in some countries, is managed by the local government
6565
type: string
6666
x-ngsi:
6767
type: Property
6868
postOfficeBoxNumber:
69-
description: 'The post office box number for PO box addresses. For example, 03578'
69+
description: The post office box number for PO box addresses. For example, 03578
7070
type: string
7171
x-ngsi:
7272
model: https://schema.org/postOfficeBoxNumber
7373
type: Property
7474
postalCode:
75-
description: 'The postal code. For example, 24004'
75+
description: The postal code. For example, 24004
7676
type: string
7777
x-ngsi:
7878
model: https://schema.org/https://schema.org/postalCode
@@ -100,7 +100,10 @@ VehicleModel:
100100
annotations:
101101
description: Annotations about the item
102102
items:
103+
description: Eventy element in the annotations
103104
type: string
105+
x-ngsi:
106+
type: Property
104107
type: array
105108
x-ngsi:
106109
model: https://schema.org/Text
@@ -118,7 +121,7 @@ VehicleModel:
118121
model: https://schema.org/brand
119122
type: Property
120123
cargoVolume:
121-
description: 'The available volume for cargo or luggage. For automobiles, this is usually the trunk volume. If only a single value is provided (type Number) it will refer to the maximum volume'
124+
description: The available volume for cargo or luggage. For automobiles, this is usually the trunk volume. If only a single value is provided (type Number) it will refer to the maximum volume
122125
minimum: 0
123126
type: number
124127
x-ngsi:
@@ -169,7 +172,7 @@ VehicleModel:
169172
type: Property
170173
units: liters per 100 kilometer
171174
fuelType:
172-
description: 'The type of fuel suitable for the engine or engines of the vehicle. Enum:''autogas, biodiesel, ethanol, cng, diesel, electric, gasoline, hybrid electric/diesel, hybrid electric/petrol, hydrogen, lpg, petrol, petrol(unleaded), petrol(leaded), other'''
175+
description: The type of fuel suitable for the engine or engines of the vehicle. Enum:'autogas, biodiesel, ethanol, cng, diesel, electric, gasoline, hybrid electric/diesel, hybrid electric/petrol, hydrogen, lpg, petrol, petrol(unleaded), petrol(leaded), other'
173176
enum:
174177
- autogas
175178
- biodiesel
@@ -213,7 +216,7 @@ VehicleModel:
213216
type: Property
214217
description: Unique identifier of the entity
215218
x-ngsi:
216-
type: Property
219+
type: Relationship
217220
image:
218221
description: An image of the item
219222
format: uri
@@ -222,20 +225,26 @@ VehicleModel:
222225
model: https://schema.org/URL
223226
type: Property
224227
location:
225-
description: 'Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon'
228+
description: Geojson reference to the item. It can be Point, LineString, Polygon, MultiPoint, MultiLineString or MultiPolygon
226229
oneOf:
227230
- description: Geojson reference to the item. Point
228231
properties:
229232
bbox:
233+
description: BBox of the Point
230234
items:
231235
type: number
232236
minItems: 4
233237
type: array
238+
x-ngsi:
239+
type: Property
234240
coordinates:
241+
description: Coordinates of the Point
235242
items:
236243
type: number
237244
minItems: 2
238245
type: array
246+
x-ngsi:
247+
type: Property
239248
type:
240249
enum:
241250
- Point
@@ -250,18 +259,24 @@ VehicleModel:
250259
- description: Geojson reference to the item. LineString
251260
properties:
252261
bbox:
262+
description: BBox coordinates of the LineString
253263
items:
254264
type: number
255265
minItems: 4
256266
type: array
267+
x-ngsi:
268+
type: Property
257269
coordinates:
270+
description: Coordinates of the LineString
258271
items:
259272
items:
260273
type: number
261274
minItems: 2
262275
type: array
263276
minItems: 2
264277
type: array
278+
x-ngsi:
279+
type: Property
265280
type:
266281
enum:
267282
- LineString
@@ -276,11 +291,15 @@ VehicleModel:
276291
- description: Geojson reference to the item. Polygon
277292
properties:
278293
bbox:
294+
description: BBox coordinates of the Polygon
279295
items:
280296
type: number
281297
minItems: 4
282298
type: array
299+
x-ngsi:
300+
type: Property
283301
coordinates:
302+
description: Coordinates of the Polygon
284303
items:
285304
items:
286305
items:
@@ -290,6 +309,8 @@ VehicleModel:
290309
minItems: 4
291310
type: array
292311
type: array
312+
x-ngsi:
313+
type: Property
293314
type:
294315
enum:
295316
- Polygon
@@ -304,17 +325,23 @@ VehicleModel:
304325
- description: Geojson reference to the item. MultiPoint
305326
properties:
306327
bbox:
328+
description: BBox coordinates of the LineString
307329
items:
308330
type: number
309331
minItems: 4
310332
type: array
333+
x-ngsi:
334+
type: Property
311335
coordinates:
336+
description: Coordinates of the MulitPoint
312337
items:
313338
items:
314339
type: number
315340
minItems: 2
316341
type: array
317342
type: array
343+
x-ngsi:
344+
type: Property
318345
type:
319346
enum:
320347
- MultiPoint
@@ -329,11 +356,15 @@ VehicleModel:
329356
- description: Geojson reference to the item. MultiLineString
330357
properties:
331358
bbox:
359+
description: BBox coordinates of the LineString
332360
items:
333361
type: number
334362
minItems: 4
335363
type: array
364+
x-ngsi:
365+
type: Property
336366
coordinates:
367+
description: Coordinates of the MultiLineString
337368
items:
338369
items:
339370
items:
@@ -343,6 +374,8 @@ VehicleModel:
343374
minItems: 2
344375
type: array
345376
type: array
377+
x-ngsi:
378+
type: Property
346379
type:
347380
enum:
348381
- MultiLineString
@@ -362,6 +395,7 @@ VehicleModel:
362395
minItems: 4
363396
type: array
364397
coordinates:
398+
description: Coordinates of the MultiPolygon
365399
items:
366400
items:
367401
items:
@@ -373,6 +407,8 @@ VehicleModel:
373407
type: array
374408
type: array
375409
type: array
410+
x-ngsi:
411+
type: Property
376412
type:
377413
enum:
378414
- MultiPolygon
@@ -421,7 +457,7 @@ VehicleModel:
421457
type: Property
422458
description: Unique identifier of the entity
423459
x-ngsi:
424-
type: Property
460+
type: Relationship
425461
type: array
426462
x-ngsi:
427463
type: Property
@@ -438,7 +474,7 @@ VehicleModel:
438474
x-ngsi:
439475
type: Property
440476
source:
441-
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'
477+
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
442478
type: string
443479
x-ngsi:
444480
type: Property
@@ -470,7 +506,7 @@ VehicleModel:
470506
model: https://schema.org/vehicleModelDate
471507
type: Property
472508
vehicleType:
473-
description: 'Type of vehicle from the point of view of its structural characteristics. This is different than the vehicle category . Enum:''agriculturalVehicle, anyVehicle, articulatedVehicle, bicycle, binTrolley, bus, car, caravan, carOrLightVehicle, carWithCaravan, carWithTrailer, cleaningTrolley, constructionOrMaintenanceVehicle, fourWheelDrive, highSidedVehicle, lorry, minibus, moped, motorcycle, motorcycleWithSideCar, motorscooter, sweepingMachine, tanker, threeWheeledVehicle, trailer, tram, twoWheeledVehicle, trolley, van, vehicleWithoutCatalyticConverter, vehicleWithCaravan, vehicleWithTrailer, withEvenNumberedRegistrationPlates, withOddNumberedRegistrationPlates, other''. The following values defined by _VehicleTypeEnum_ and _VehicleTypeEnum2_, [DATEX 2 version 2.3](http://d2docs.ndwcloud.nu/_static/umlmodel/v2.3/index.htm)'
509+
description: Type of vehicle from the point of view of its structural characteristics. This is different than the vehicle category . Enum:'agriculturalVehicle, anyVehicle, articulatedVehicle, bicycle, binTrolley, bus, car, caravan, carOrLightVehicle, carWithCaravan, carWithTrailer, cleaningTrolley, constructionOrMaintenanceVehicle, fourWheelDrive, highSidedVehicle, lorry, minibus, moped, motorcycle, motorcycleWithSideCar, motorscooter, sweepingMachine, tanker, threeWheeledVehicle, trailer, tram, twoWheeledVehicle, trolley, van, vehicleWithoutCatalyticConverter, vehicleWithCaravan, vehicleWithTrailer, withEvenNumberedRegistrationPlates, withOddNumberedRegistrationPlates, other'. The following values defined by _VehicleTypeEnum_ and _VehicleTypeEnum2_, [DATEX 2 version 2.3](http://d2docs.ndwcloud.nu/_static/umlmodel/v2.3/index.htm)
474510
enum:
475511
- agriculturalVehicle
476512
- bicycle
@@ -521,12 +557,12 @@ VehicleModel:
521557
- modelName
522558
- manufacturerName
523559
type: object
524-
x-derived-from: ""
525-
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) 2022 Contributors to Smart Data Models Program'
560+
x-derived-from: ''
561+
x-disclaimer: Redistribution and use in source and binary forms...
526562
x-license-url: https://github.com/smart-data-models/dataModel.Transportation/blob/master/VehicleModel/LICENSE.md
527563
x-model-schema: https://smart-data-models.github.io/dataModel.Transportation/VehicleModel/schema.json
528-
x-model-tags: ""
529-
x-version: 0.0.1
564+
x-model-tags: ''
565+
x-version: 0.0.2
530566
```
531567
</details>
532568
<!-- /60-ModelYaml -->

0 commit comments

Comments
 (0)