Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support for other keywords #48

Open
duncandewhurst opened this issue Jun 21, 2023 · 0 comments
Open

Support for other keywords #48

duncandewhurst opened this issue Jun 21, 2023 · 0 comments

Comments

@duncandewhurst
Copy link

Open-Telecoms-Data/open-fibre-data-standard#274 makes use of the additionalProperties keyword, which is not currently rendered by the directive.

Rather than adding columns for each possible JSON Schema keyword, perhaps we could have something like a 'constraints' column:

Field Description Type Required Constraints
readyForServiceDate Ready for service date: The date this span was ready to carry traffic. For spans with multiple network providers, the earliest of the dates at which each provider’s network was ready to carry traffic on this span. string format: date
route Span route: In the JSON publication format, a GeoJSON LineString geometry describing the route of this span. In the CSV publication format, a well-known text LINESTRING geometry. See Geometry object additionalProperties: false

In the meantime, I've handled this by updating the script that generates the schema reference documentation to add some text above the schema table to indicate to readers that additional properties are not permitted.

A side note, but I think we should also be documenting the meaning of the keywords and values in a standard's schema as part of that standard's documentation. In which case, the directive could link to those documentation pages so readers can find out, for example, what the date format is.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant