Serverless API docs improvements - #657
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
96db235 to
9046cf3
Compare
ajyoung
left a comment
ajyoung
left a comment
There was a problem hiding this comment.
In the "Make a request to the Data Plane APIs" section, consider replacing "Get Cluster" with "Get Cluster or Serverless Cluster" in steps 1 and 2.
| + | ||
| [,bash] | ||
| ---- | ||
| curl -H 'Authorization: Bearer <token>' https://api.redpanda.com/v1beta2/serverless/regions?cloud_provider=CLOUD_PROVIDER_AWS |
There was a problem hiding this comment.
Single quotes are needed around the last argument (the URL) because otherwise the question mark will be interpreted as a shell character instead of as part of the URL.
One other thing, we may want to note somewhere that if the bearer token is filled in with a shell substitution variable (e.g. curl -H "Authorization: Bearer $TOKEN" https://api.redpanda.com/v1beta2/resource-groups), then that argument to the command needs to be surrounded by double quotes rather than single quotes. This is a well known thing but people may forget when copy/pasting commands. This is less important but just a thought.
There was a problem hiding this comment.
Thanks @ajyoung , I have exactly the same suggestion
| [,bash] | ||
| ---- | ||
| curl -H 'Authorization: Bearer <token>' https://api.redpanda.com/v1beta2/serverless/regions/ | ||
| curl -H 'Authorization: Bearer <token>' https://api.redpanda.com/v1beta2/serverless/regions?cloud_provider=CLOUD_PROVIDER_AWS |
There was a problem hiding this comment.
Single quotes are needed around the last argument (the URL) because otherwise the question mark will be interpreted as a shell character instead of as part of the URL.
9046cf3 to
3c866bf
Compare
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
…erverless-api-doc-impvt
|
Given that you merged redpanda-data/cloud-docs#10, can you close this one @kbatuigas ? |
4 participants
Description
Resolves https://github.com/redpanda-data/documentation-private/issues/2629
Review deadline: 1 Aug
Page previews
API Quickstart
Use the Control Plane API with Serverless
Checks