Skip to content

fixed api - #243

Merged
sedv8808 merged 1 commit into
productionfrom
develop
Nov 2, 2026
Merged

sedv8808 merged 1 commit into
productionfrom
develop

Conversation

@sedv8808

@sedv8808 sedv8808 commented Nov 2, 2026

Copy link
Copy Markdown
Collaborator

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:

  • Renamed the single dataset type parameter from datasettypeQuery to datasettypeSingleQuery and 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]
  • Renamed the list-accepting parameter from datasettypeListQuery to datasettypeQuery, and added a comment explaining that the key must remain datasettypeQuery for compatibility with the neotoma2 R package. [1] [2]

Endpoint parameter updates:

  • Updated all relevant endpoint parameter lists in openapi.yaml and openapi/paths/v20/data.yml to reference the correct parameter (datasettypeSingleQuery for single-type endpoints, datasettypeQuery for multi-type endpoints), replacing any outdated references. [1] [2] [3] [4] [5] [6] [7] [8] [9] [10]

Copilot AI balanced review requested due to automatic review settings November 2, 2026 23:32

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🟢 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 datasettypeSingleQuery and the list component to datasettypeQuery.
  • 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

@sedv8808
sedv8808 merged commit 9d05e26 into production Nov 2, 2026
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants