Add option for custom openapi metadata and dataset template file #277
Conversation
This file contains hidden or 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
lukas-phaf
reviewed
Oct 27, 2025
api/openapi/openapi_metadata.py
Outdated
Comment on lines
17
to
32
| openapi_metadata = { | ||
| "title": "EDR Observations API Europe EUMETNET", | ||
| "description": ( | ||
| "OGC EDR API data service for European meteorological observations from EUMETNET," | ||
| " co-funded by the European Union." | ||
| ), | ||
| "contact": { | ||
| "name": "EUMETNET", | ||
| "url": "https://www.eumetnet.eu/about-us/", | ||
| "email": "[email protected]", | ||
| }, | ||
| "license_info": { | ||
| "name": "CC-BY-4.0", | ||
| "url": "https://creativecommons.org/licenses/by/4.0/", | ||
| }, | ||
| } |
There was a problem hiding this comment.
Why not keep it symmetric and move this to a JSON file as well?
Comment on lines
+15
to
+16
| | JINJA2_TEMPLATES | Path to a folder with jinja2 templates to override the default templates used by the API. See template section for details | ☐ | | ||
| | OPENAPI_METADATA_PATH | Path to an alternative OpenAPI metadata json file. It need to have the same fields as the openapi/openapi_metadata.py file. | ☐ | |
There was a problem hiding this comment.
What is the mechanism to inject the JINJA templates and json files into the docker container?
api/routers/feature.py
Outdated
Comment on lines
67
to
70
| Query( | ||
| description="Institution that published the data", | ||
| openapi_examples=openapi_examples.institution, | ||
| ), |
There was a problem hiding this comment.
It looks like your line width settings are different from 120 which is enforced in the pre-commit hooks...
Can you change that, so we don't get these unneeded diffs? ;-)
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.
No description provided.