feat: add client_id() header method and multi-platform search support#111
Open
stark256-spec wants to merge 1 commit into
Open
feat: add client_id() header method and multi-platform search support#111stark256-spec wants to merge 1 commit into
stark256-spec wants to merge 1 commit into
Conversation
- Add Query.client_id() convenience method that sets the Client-Id header. When called without arguments it defaults to python_cmr-<version>; when called with a name it produces <name>/python_cmr-<version>. Closes nasa#49. - Update GranuleCollectionBaseQuery.platform() to accept either a single string or a list of strings, matching CMR's support for multi-platform filtering. Closes nasa#80.
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
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.
Closes #49, closes #80.
Changes
client_id()method onQuery(fixes #49)Adds a
client_id(client_id=None)convenience method to theQuerybase class, analogous totoken()andbearer_token(), that sets theClient-Idheader described in the CMR Search API docs.None): setsClient-Id: python_cmr-<version>so that NASA Operations can identify requests from this library automatically.Client-Id: <your-app>/python_cmr-<version>, appending the library version for traceability.Multi-platform support in
platform()(fixes #80)Updates
GranuleCollectionBaseQuery.platform()to accept either a single string or a list of strings, matching CMR's native support for filtering by multiple platforms.Tests
tests/test_queries.pycoveringclient_id()default, custom name, and header isolation.GranuleQueryandCollectionQuery) for multi-platform lists.