Clean up Cloud API specs #13
Merged
Conversation
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
|
ℹ️ API content change detected: No structural change, nothing to display.
|
|
ℹ️ API content change detected: No structural change, nothing to display.
|
kbatuigas
commented
Aug 8, 2025
| $ref: '#/components/schemas/SchemaRegistrySpec' | ||
| throughput_tier: | ||
| description: '[Throughput tier](https://docs.redpanda.com/api/cloud-controlplane-api/#api-description) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' | ||
| description: '[Throughput tier](https://docs.redpanda.com/api/doc/cloud-controlplane/topic/topic-regions-and-usage-tiers) of the cluster. See also: Redpanda Cloud [Dedicated tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/dedicated-tiers/#dedicated-usage-tiers) and [BYOC tiers](https://docs.redpanda.com/redpanda-cloud/reference/tiers/byoc-tiers/).' |
Contributor
Author
There was a problem hiding this comment.
Do we need to add redirects in Netlify for these?
There was a problem hiding this comment.
if bump doesn't offer an alias solution, yes.
kbatuigas
commented
Aug 8, 2025
| 1. Select an operation, for example **Create topic** or **List users**. | ||
| 1. In the URL field, add the data plane API URL. You can now make Data Plane API requests to your target cluster. | ||
|
|
||
| See also: [Data Plane API Quickstart](https://docs.redpanda.com/api/doc/cloud-dataplane/topic/topic-quickstart) |
Contributor
Author
There was a problem hiding this comment.
Could we possibly use relative URLs? These technically don't live in the same spec but would something like ../../../cloud-dataplane/topic/topic-quickstart (however far back it needs to go to get to a base URL) work? Not sure when these reference would be evaluated however.
paulohtb6
reviewed
Aug 8, 2025
| 1. Click **Send Request** on the code example to the right. | ||
| The Response block should populate with an `access_token` value. Copy the string value without the quotes. To make your next request to a different endpoint in the API Explorer, add the access token in the Authentication field. | ||
| > **Warning:** API requests from this page are executed against your actual environment and data, not a sandbox. | ||
| If you successfully retrieve an access token, it is valid for one hour. You can use the same token in requests to both Control Plane and Data Plane API endpoints, for as long as the token is valid. |
There was a problem hiding this comment.
Suggested change
| If you successfully retrieve an access token, it is valid for one hour. You can use the same token in requests to both Control Plane and Data Plane API endpoints, for as long as the token is valid. | |
| If you successfully retrieved an access token, it is valid for one hour. You can use the same token in requests to both Control Plane and Data Plane API endpoints, for as long as the token is valid. |
paulohtb6
reviewed
Aug 8, 2025
| 1. Enter the `client_id` and `client_secret` values you generated using the service account. | ||
| 1. For `audience`, select `cloudv2-production.redpanda.cloud`. | ||
| 1. Click **Send Request** on the code example to the right. | ||
| If you successfully retrieve an access token, it is valid for one hour. You can use the same token in requests to both Control Plane and Data Plane API endpoints, for as long as the token is valid. |
There was a problem hiding this comment.
Suggested change
| If you successfully retrieve an access token, it is valid for one hour. You can use the same token in requests to both Control Plane and Data Plane API endpoints, for as long as the token is valid. | |
| If you successfully retrieved an access token, it is valid for one hour. You can use the same token in requests to both Control Plane and Data Plane API endpoints, for as long as the token is valid. |
Contributor
Author
There was a problem hiding this comment.
This describes an action or scenario that hasn't necessarily been carried out yet (the following sections walks through the steps to get a token), so let's keep it to the present tense for simplicity.
paulohtb6
reviewed
Aug 8, 2025
| 1. Go to **API Servers** in the sidebar and select “\{dataplane_api_url} - Data Plane API”. Paste the URL into the `dataplane_api_url` field. | ||
| 1. To create a new Redpanda topic, make a Create Topic request. | ||
| ``` | ||
| echo "hello" | rpk topic produce test-topic |
Contributor
Author
There was a problem hiding this comment.
Missing key-value - I'll update.
paulohtb6
approved these changes
Aug 8, 2025
To follow our style guide and be consistent with the Cloud UI
kbatuigas
force-pushed
the
clean-up-cloud-api-specs
branch
from
843bb3b to
91ddddf
Compare
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.
These changes will have to be backported to cloudv2.