smart-data-models / datamodel.pointofinterest Goto Github PK

In the model:
https://github.com/smart-data-models/dataModel.PointOfInterest/blob/master/PointOfInterest/model.yaml

contactPoint:
description: 'Contact point for the museum.'
type: Property
x-ngsi:
model: https://schema.org/ContactPoint

Since PointOfInterest could be anything based on the 'Category' defined, the above description for contactPoint referring to Museum should be replaced.

Under https://github.com/smart-data-models/dataModel.PointOfInterest/blob/master/Museum/model.yaml
Looks like content under attribute featuredArtist and id have got mixed up. See below:

featuredArtist:
description: 'Main featured artist(s) at this museum.'
items:
anyOf:
- anyOf: &museum_-properties-id-_anyof
- description: 'Property. Identifier format of any NGSI entity'
maxLength: 256
minLength: 1
pattern: ^[\w-.{}$+*[]`|~^@!,:\]+$
type: string
- description: 'Property. Identifier format of any NGSI entity'
format: uri
type: string
description: 'Property. Unique identifier of the entity'
- type: string
minItems: 1
type: Property
uniqueItems: true
x-ngsi:
model: https://schema.org/Person

id:
anyOf: *museum_-properties-id-_anyof
description: 'Unique identifier of the entity'
type: Property

Also the id is defined as follows for Store: "anyOf: &store_-properties-owner-items-anyof", PointOfInterest: "anyOf: &pointofinterest-properties-owner-items-anyof", Beach: anyOf: &beach-properties-owner-items-_anyof

So, the id for Museum too should start with & instead of *, I assume.
I am not really sure about the relation between id and owner. Will be great if you can mention that as well.

In this link, https://ngsi-ld-tutorials.readthedocs.io/en/latest/understanding-%40context.html
attributes temperature and fillingLevel are added to Building by specifying allOf Building and the additional two properties.

Why isn't Museum(or Beach or Store) https://raw.githubusercontent.com/smart-data-models/dataModel.PointOfInterest/master/Museum/model.yaml extended from PointOfInterest https://raw.githubusercontent.com/smart-data-models/dataModel.PointOfInterest/master/PointOfInterest/model.yaml similarly with the additional attributes?

Issues in generated yaml from schema.json file

• Why are certain attributes with type as string generated as property?

For instance 'description' and 'dataProvider' below:

        "dataProvider": {
          "type": "string",
          "description": "Property. A sequence of characters identifying the provider of the harmonised data entity."
        },
        "description": {
          "type": "string",
          "description": "Property. A description of this item"
        },

are generated as:

    dataProvider:
      description: 'A sequence of characters identifying the provider of the harmonised data entity.'
      type: Property
    description:
      description: 'A description of this item'
      type: Property

• Why are certain attributes with type as array generated as Property?

For instance category below:

	"category": {
	    "type": "array",
	    "description": "Property. Model:'https://schema.org/Text'. Category of this point of interest. Allowed values: Those defined by the [Factual taxonomy](https://github.com/Factual/places/blob/master/categories/factual_taxonomy.json) together with the extended categories described by the specification. For instance the value `113` corresponds to beaches, and the value `311` corresponds to museums.",
	    "items": {
		"type": "string"
	    },
	    "minItems": 1
	},

are generated as:

   category:
      description: 'Category of this point of interest. Allowed values: Those defined by the [Factual taxonomy](https://github.com/Factual/places/blob/master/categories/factual_taxonomy.json) together with the extended categories described by the specification. For instance the value `113` corresponds to beaches, and the value `311` corresponds to museums.'
      items:
        type: string
      minItems: 1
      type: Property
      x-ngsi:
        model: https://schema.org/Text

In the following model.yaml files:

https://github.com/smart-data-models/dataModel.PointOfInterest/blob/master/Store/model.yaml
https://github.com/smart-data-models/dataModel.PointOfInterest/blob/master/Beach/model.yaml
https://github.com/smart-data-models/dataModel.PointOfInterest/blob/master/PointOfInterest/model.yaml
https://github.com/smart-data-models/dataModel.PointOfInterest/blob/master/Museum/model.yaml

Under properties -> address - "For example, Spain" is incorrect in description of postOfficeBoxNumber and postalCode.

postOfficeBoxNumber:
         description: 'Property. The post office box number for PO box addresses. **For example, Spain.** Model:''https://schema.org/postOfficeBoxNumber'''
         type: string
 postalCode:
         description: 'Property. The postal code. **For example, Spain**. Model:''https://schema.org/https://schema.org/postalCode'''
         type: string

In the category of this point of interest. Allowed values: Those defined by the Factual taxonomy.
The link to the list of available categories no longer exists, where can we consult this list?

https://github.com/smart-data-models/dataModel.PointOfInterest/blob/master/PointOfInterest/model.yaml
required attributes are mentioned as:
- id, - type, - category and - name
Since the name 'Point of Interest' is a geographical indication, shouldn't location or address be included as required?

Also for
https://github.com/smart-data-models/dataModel.PointOfInterest/blob/master/Store/model.yaml
required attributes are mentioned as:
- id, - type, - name and - description
Isn't description usually optional? Instead, shouldn't location or address be required?

The following entities have correctly defined location attribute as a required field
https://github.com/smart-data-models/dataModel.PointOfInterest/blob/master/Museum/model.yaml
https://github.com/smart-data-models/dataModel.PointOfInterest/blob/master/Store/model.yaml
required attributes are mentioned as:
- id, - type, - location and - name