Update openapi spec - servers description #1575
Open
Conversation
This file contains 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
|
Why are the open api specs removed? |
Ran |
bojand
approved these changes
Jan 7, 2025
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.
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
serversfield 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.