New CDS API Client Interface#81
Open
nmearl wants to merge 10 commits into
Open
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This PR introduces an api client interface that is built automatically from the openapi specs produced in the cds-api package.
Generated pydantic models are created by running the
/scripts/generate_models.shfile. This produces (currently) two_generated_*.pyfiles in thesrc/cds_client/modelsdirectory. These generated models are then wrapped by proxy models in thesrc/cds_client/models/base.pyandsrc/cds_client/models/hubble.pyfiles. This is done so that if api definitions change or get renamed, down-stream packages that rely on cds-client will not need to change their model reference names, since they would be using the proxy models.The README provides examples of using the client to interface with the API.