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

[Feature] Improve references to employed schemas in OpenAPI #157

Closed
fmigneault opened this issue May 26, 2020 · 1 comment · Fixed by #551
Closed

[Feature] Improve references to employed schemas in OpenAPI #157

fmigneault opened this issue May 26, 2020 · 1 comment · Fixed by #551
Assignees
Labels
ci/doc Issue related to documentation of the package feature/oas Issues related to OpenAPI specifications. project/OGC Related to OGC testbeds or relavant projects. triage/conformance Issue related to fixing/ensuring compliance to specifications. triage/enhancement New feature or request

Comments

@fmigneault
Copy link
Collaborator

Each schema defined in our OpenAPI spec should refer to the corresponding schema from the OGC-API WPS-REST bindings :
https://github.com/opengeospatial/wps-rest-binding/tree/master/core/openapi/schemas

We could add this information using JSON-LD style fields, eg:

"@context": "https://raw.githubusercontent.com/opengeospatial/wps-rest-binding/master/core/openapi/schemas",
"@schema": "complexData.yml"

Field @context will probably need to be updated eventually to http://www.opengis.net/spec/ogcapi-processes/1.0/conf/core for the official reference, but since it is not yet available, the above raw-github-content will be more descriptive. (see : opengeospatial/ogcapi-processes#71)

We should also display the objects/classes schemas that are defined under OpenAPI UI so they can be viewed individually/independently of the full context within a request/response body. This would ease visibility. At the moment only routes are displayed, but the schemas can also be shown (probably a config parameter to set in the SwaggerUI generator).

We should also apply title field of the employed schemas to match exactly the name of the reference schema from OGC WPS-REST bindings wherever applicable. This would avoid ambiguities.

@fmigneault fmigneault added triage/enhancement New feature or request ci/doc Issue related to documentation of the package triage/conformance Issue related to fixing/ensuring compliance to specifications. feature/oas Issues related to OpenAPI specifications. labels May 26, 2020
@fmigneault fmigneault self-assigned this May 26, 2020
@fmigneault
Copy link
Collaborator Author

@fmigneault fmigneault added the project/OGC Related to OGC testbeds or relavant projects. label Feb 18, 2021
@fmigneault fmigneault added this to the OGC-API Conformances milestone May 10, 2021
fmigneault added a commit that referenced this issue Aug 27, 2021
fmigneault added a commit that referenced this issue Aug 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ci/doc Issue related to documentation of the package feature/oas Issues related to OpenAPI specifications. project/OGC Related to OGC testbeds or relavant projects. triage/conformance Issue related to fixing/ensuring compliance to specifications. triage/enhancement New feature or request
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant