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

clarify bbox parameter requirement for cube/items queries #561

Open
tomkralidis opened this issue Jul 17, 2024 · 6 comments · May be fixed by #564
Open

clarify bbox parameter requirement for cube/items queries #561

tomkralidis opened this issue Jul 17, 2024 · 6 comments · May be fixed by #564
Assignees
Labels
API EDR V1.2 Non-breaking change for Version 1.2 bug Something isn't working

Comments

@tomkralidis
Copy link
Collaborator

The bbox query is required for the following query types:

However, the bbox parameter definition shows required: false.

  1. cube query: https://github.com/opengeospatial/ogcapi-environmental-data-retrieval/blob/master/core/standard/openapi/paths/queries/cube.yaml
  2. items query: https://github.com/opengeospatial/ogcapi-environmental-data-retrieval/blob/master/core/standard/openapi/paths/queries/items.yaml
  3. bbox parameter (referenced by 1 and 2): https://github.com/opengeospatial/ogcapi-environmental-data-retrieval/blob/master/core/standard/openapi/parameters/core/bbox.yaml

This yielded errors on EDR CITE against my pygeoapi instance (CITE is testing that the OpenAPI .../cube endpoint has a required bbox parameter).

If the bbox parameter is required for all of the queries it applies to, then the bbox parameter definition needs to be updated (required: true).

Happy to PR if this is the intended behaviour.

@chris-little
Copy link
Contributor

chris-little commented Jul 18, 2024

@tomkralidis As the cube query was updated from the original WKT polygon syntax to a bbox syntax, for users' convenience (and probably implementers' convenience too), I think the PR has the correct behaviour.
But, does the WKT polygon syntax need to be supported for backward compatibility? So maybe the current behaviour is correct, but we need some documentation to say both query syntaxes supported? @m-burgoyne Thoughts?

@m-burgoyne
Copy link
Collaborator

@tomkralidis @chris-little I there will need to be two different bbox definitions, the items query can still use the current bbox parameter definition, but there needs to be a new definition for the cube query which has a required attribute of true

@tomkralidis
Copy link
Collaborator Author

@m-burgoyne
Copy link
Collaborator

@tomkralidis That is an error in the document, the Items query bbox should be optional, so that document will need to be updated

@chris-little
Copy link
Contributor

@tomkralidis @m-burgoyne Is this an error only in V1.1, to be addressed in V1.2, or do we need a V1.0.2 and/or a V1.1.1?

@m-burgoyne
Copy link
Collaborator

@chris-little V1.0.2, V1.1.1 and v1.2

@chris-little chris-little added bug Something isn't working API EDR V1.2 Non-breaking change for Version 1.2 labels Sep 19, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API EDR V1.2 Non-breaking change for Version 1.2 bug Something isn't working
Projects
None yet
6 participants