Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update openapi spec - servers description #1575

Merged
merged 3 commits into from
Jan 27, 2025

Conversation

kbatuigas
Copy link
Contributor

As part of work to provide separate API references for the Control Plane and Data Plane APIs (docs PR: redpanda-data/docs#929), we need to update the data plane OpenAPI spec to remove unnecessary fields and descriptions that pertain to the control plane only. This PR updates the servers field in the spec so that readers go this section of the API reference doc (after the split) https://docs.redpanda.com/api/cloud-api/#servers they will know what to do to get the base URL for data plane APIs.

@bojand
Copy link
Member

bojand commented Jan 7, 2025

Why are the open api specs removed?

@kbatuigas
Copy link
Contributor Author

Why are the open api specs removed?

Ran task proto:generate again and the spec files are back, thank you for the heads up! 18d24fa

@kbatuigas kbatuigas force-pushed the kb/docs/dataplane-spec-servers branch from 18d24fa to 253fb9d Compare January 24, 2025 21:59
@kbatuigas
Copy link
Contributor Author

Added some quick edits to Cloud Storage service

@bojand bojand self-requested a review January 25, 2025 01:54
@weeco weeco merged commit 173dbc0 into redpanda-data:master Jan 27, 2025
3 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.

3 participants