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

Resolve and improve schema references in generated OpenAPI endpoint and API JSON responses #525

Open
fmigneault opened this issue Feb 25, 2023 · 0 comments
Assignees
Labels
triage/bug Something isn't working

Comments

@fmigneault
Copy link
Collaborator

fmigneault commented Feb 25, 2023

Describe the bug

Multiple schema references are inconsistent or broken due to OGC API repository restructures.

Original references should be used for corresponding schemas.
Specific references for OGC API - Processes should be resolved.

All responses from Weaver should include a $schema reference to help machine-readable parsing and validation.

Optionally, nested objects could also offer some $schema references when those are useful for understanding the definitions.
For example, a schema field under a Process Description I/O uses JSON-schema specification to describe it.
Adding $schema: http://json-schema.org/draft-07/schema# scoped under that I/O would greatly facilitate parsing that nested object by itself without having to resolve the full parent schema that contains it.

References

@fmigneault fmigneault added the triage/bug Something isn't working label Feb 25, 2023
@fmigneault fmigneault self-assigned this Feb 25, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage/bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant