search

opengeospatial / ogcapi-records

An open standard for the discovery of geospatial resources on the Web.
https://ogcapi.ogc.org/records
Other
58 stars 27 forks source link

schema validation issues #263

Closed tomkralidis closed 1 year ago

tomkralidis commented 1 year ago

As part of automated WMO Core Metadata Profile (WCMP2) validation, we are implementing a schema which extends the Records model per https://github.com/wmo-im/wcmp2/blob/3aabc432ae2d66fd408a54475ef41a286058717a/schemas/wcmpRecordGeoJSON.yaml

We create a bundled schema of the resulting record schema using Stoplight Studio. Steps can be found at https://github.com/wmo-im/wcmp2/blob/main/schemas/README.md (note: if anyone is aware of existing Python tooling that can automate conversion from YAML to JSON [including reference resolving] I'll gladly switch).

We then use check-jsonschema to perform validation of instance documents against the bundle as part of CI workflow.

check-jsonschema is reporting the following errors with the schema proper:

PR to fix is in #262, but I'd like some feedback on the impact of these changes related to other tooling.

cc @pvretano @kalxas @m-mohr

m-mohr commented 1 year ago
  • changing from "pattern": "^+[1-9]{1}[0-9]{3,14}$" to "^\\+[1-9]{1}[0-9]{3,14}$", but I'm not sure if this is expected per se. It is critical that we provide a few examples for this property. Can someone provide?

This is expected. It just fixes a regexp from invalid to valid.

Here is an example: https://github.com/opengeospatial/ogcapi-records/issues/263#issuecomment-1557046209

tomkralidis commented 1 year ago

Is this a relevant example then? I can add to PR but just wanted to make sure :)

m-mohr commented 1 year ago

What is a "relevant" example? It's just a random example of a phone number...

tomkralidis commented 1 year ago

Thanks. I wanted to ensure it's random so that someone is not receiving years of phone calls because of the specification :)

m-mohr commented 1 year ago

~Not sure, 83 is the prefix of University of Münster. I haven't checked whether 98765 is used. But the issue always exists. A phone number that is "random" and "unused" right now may be used tomorrow.~

m-mohr commented 1 year ago

Hah, I found some example phone numbers that are reserved as examples: https://softwareengineering.stackexchange.com/questions/376535/whats-the-phone-number-equivalent-of-example-org

So you can use:

tomkralidis commented 1 year ago

Updated to +14165550142