docs: update open api static spec #846
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Code Coverage (Ubuntu)
Minimum allowed coverage is Generated by 🐒 cobertura-action against 7e46328 |
|
Code Coverage (Windows)
Minimum allowed coverage is Generated by 🐒 cobertura-action against 7e46328 |
bjgiraudon
force-pushed
the
839-improve-openapi-doc
branch
2 times, most recently
from
a9ab5d4
to
0e66de3
Compare
2 tasks
sbrunato
requested changes
Oct 5, 2023
There was a problem hiding this comment.
Needed changes:
- /api : example to {}
- /queryables: adapt description (no CQL2)
- /collections: remove parameters
- /collections/{collectionId}/queryables: adapt description (no CQL2)
- /catalogs/{catalogPath}/items/{featureId}/download: remove "string" for 200 example value
- add /catalogs/{catalogPath}/items
- *: change 404 example
- *: add 400 code in responses
- *: change 500 response example format
bjgiraudon
force-pushed
the
839-improve-openapi-doc
branch
4 times, most recently
from
c017233
to
e290527
Compare
sbrunato
requested changes
Oct 13, 2023
There was a problem hiding this comment.
Please describe more the query extension usage and adapt to our implementation (see #839 description). Details for accepted operators and parameters can be found in rest.utils.get_criterias_from_metadata_mapping() that uses conf from resources/stac_provider.yml
bjgiraudon
force-pushed
the
839-improve-openapi-doc
branch
4 times, most recently
from
9ab05c3
to
8dcf05b
Compare
sbrunato
requested changes
Oct 18, 2023
bjgiraudon
force-pushed
the
839-improve-openapi-doc
branch
from
8dcf05b
to
a31f93f
Compare
sbrunato
requested changes
Nov 7, 2023
bjgiraudon
force-pushed
the
839-improve-openapi-doc
branch
from
a31f93f
to
f5f2a01
Compare
sbrunato
requested changes
Nov 16, 2023
There was a problem hiding this comment.
- please restore previous server methods sorting, as some are not working any more (
/catalogs/{catalogs}/items/{item_id}/downloadinterpreted as/catalogs/{catalogs}) /collections/{collection_id}/items/{item_id}and/collections/{collection_id}/items/{item_id}/downloadforms are opening together when you click on one of them ...- remove query from GET /search
- give a working example in POST /search
- give more details on searchBody in POST /search (display its description or at least a link to it)
bjgiraudon
force-pushed
the
839-improve-openapi-doc
branch
from
b55c370
to
154f497
Compare
bjgiraudon
force-pushed
the
839-improve-openapi-doc
branch
from
154f497
to
f998087
Compare
bjgiraudon
force-pushed
the
839-improve-openapi-doc
branch
from
f998087
to
65fa018
Compare
sbrunato
approved these changes
Nov 17, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR updates the openAPI static file located at
./eodag/resources/stac_api.yml, updating the description and summaries of endpoints as well as adding aqueryentry in the list of parameters.It fixes the issue #839