Repository navigation
fixed api - #243
Merged
Merged
fixed api#243
Conversation
There was a problem hiding this comment.
🟢 Approval recommended
No active review issues block approval of the dataset-type parameter changes.
No open issues 🎉
What changed in this PR
This PR standardizes dataset-type parameter definitions in the OpenAPI specification, distinguishing single-value endpoints from list-accepting endpoints while preserving the list parameter key expected by the neotoma2 R client.
Changes:
- Renames the single-value component to
datasettypeSingleQueryand the list component todatasettypeQuery. - Updates endpoint references in both the modular and bundled specifications.
- Clarifies parameter descriptions and documents the client-compatibility naming requirement.
| File | Description |
|---|---|
openapi/paths/v20/data.yml |
Updates endpoint references to the appropriate dataset-type component. |
openapi/components/parameters/parameters.yml |
Renames components and clarifies usage and compatibility requirements. |
openapi.yaml |
Mirrors the component and endpoint-reference changes in the bundled specification. |
Review effort: Balanced
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.
This pull request updates the OpenAPI specification to clarify and standardize the usage of dataset type query parameters across the API. The changes distinguish between endpoints that accept a single dataset type versus those that accept a list, and ensure parameter naming is consistent and compatible with client libraries like the neotoma2 R package.
Parameter naming and usage standardization:
datasettypeQuerytodatasettypeSingleQueryand updated its description to clarify that it only accepts a single type; also fixed the reference to list-accepting routes in its description. [1] [2]datasettypeListQuerytodatasettypeQuery, and added a comment explaining that the key must remaindatasettypeQueryfor compatibility with the neotoma2 R package. [1] [2]Endpoint parameter updates:
openapi.yamlandopenapi/paths/v20/data.ymlto reference the correct parameter (datasettypeSingleQueryfor single-type endpoints,datasettypeQueryfor multi-type endpoints), replacing any outdated references. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]