-
Notifications
You must be signed in to change notification settings - Fork 38
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
Split cloud API reference #929
Open
kbatuigas
wants to merge
15
commits into
api
Choose a base branch
from
DOC-780-Cloud-API-split-reference-into-control-plane-and-data-plane
base: api
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from 4 commits
Commits
Show all changes
15 commits
Select commit
Hold shift + click to select a range
0a91f60
Try with sample spec files
kbatuigas e61c14b
Reorganize slots to work with two separate reference pages
kbatuigas 71f2790
Use link macro instead for the new reference pages
kbatuigas 316d6c1
Fix URLs
kbatuigas 0af88be
Remove placeholder specs
kbatuigas ee4272a
auto-docs: Update Cloud API spec
kbatuigas 51c8920
Merge branch 'update-branch-api' into DOC-780-Cloud-API-split-referen…
kbatuigas 15a70c1
Edit reference overviews
kbatuigas 1e4fd94
Missed change to Control Plane
kbatuigas 80566f9
Remove old cloud API xref
kbatuigas 6a19672
auto-docs: Update Cloud API spec
kbatuigas 94151f2
Merge branch 'update-branch-api' into DOC-780-Cloud-API-split-referen…
kbatuigas 7cd63c8
Add Cloud API index
kbatuigas 65b5715
Modify specs for now while awaiting cloudv2 source changes
kbatuigas 45eb69d
info.description is not needed because there is an overview section
kbatuigas File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
651 changes: 631 additions & 20 deletions
651
modules/ROOT/attachments/cloud-api.yaml → ...T/attachments/cloud-controlplane-api.yaml
Large diffs are not rendered by default.
Oops, something went wrong.
4,672 changes: 4,672 additions & 0 deletions
4,672
modules/ROOT/attachments/cloud-dataplane-api.yaml
Large diffs are not rendered by default.
Oops, something went wrong.
This file was deleted.
Oops, something went wrong.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| = Control Plane API | ||
| :page-api-spec-url: api:ROOT:attachment$cloud-controlplane-api.yaml | ||
| :page-layout: swagger | ||
| :page-try-it: true |
File renamed without changes.
3 changes: 1 addition & 2 deletions
3
modules/ROOT/pages/cloud/auth/auth.adoc → ...T/pages/cloud-controlplane/auth/auth.adoc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,7 +1,6 @@ | ||
| :page-layout: api-partial | ||
|
|
||
| . To <<try-the-cloud-api,issue requests to the Cloud API from this page>>, click *Get Token*. | ||
| . To issue requests to the Control Plane API from this page, click *Get Token*. | ||
| . If successful, the text “1 API key applied” displays under the *Authentication* header. The token is valid for one hour. | ||
| . Make sure to choose the correct <<servers,API server>> before making requests. | ||
|
|
||
| See xref:redpanda-cloud:manage:api/cloud-api-authentication.adoc[Cloud API Authentication] for more information. |
30 changes: 30 additions & 0 deletions
30
modules/ROOT/pages/cloud-controlplane/overview/overview.adoc
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,30 @@ | ||
| :page-layout: api-partial | ||
|
|
||
| The Redpanda Cloud API is a collection of REST APIs that allow you to interact with different parts of Redpanda Cloud. The Control Plane API enables you to programmatically manage your clusters, networks, and resource groups. | ||
|
|
||
| To familiarize yourself with Redpanda Cloud API basics, see the xref:redpanda-cloud:manage:api/cloud-api-overview.adoc[Redpanda Cloud API Overview]. To get started using the API, try the xref:redpanda-cloud:manage:api/cloud-api-quickstart.adoc[Quickstart]. | ||
|
|
||
| NOTE: To see the available endpoints for managing resources within your clusters, such as topics, users, access control lists (ACLs), and connectors, see the link:https://docs.redpanda.com/api/cloud-dataplane-api.html[Data Plane API Reference]. | ||
|
|
||
| == Requirements | ||
|
|
||
| To use the Cloud API: | ||
|
|
||
| * You must be a customer with an existing organization in Redpanda Cloud. | ||
| * You can only use one organization for authentication. See xref:redpanda-cloud:manage:api/cloud-api-authentication.adoc[Cloud API Authentication] for steps to authenticate API requests. | ||
|
|
||
| == Control Plane API URL | ||
|
|
||
| The xref:redpanda-cloud:manage:api/cloud-api-overview.adoc#control-plane-api-url[*base URL*] of the Control Plane API for all organizations is: | ||
|
|
||
| ``` | ||
| https://api.redpanda.com | ||
| ``` | ||
|
|
||
| == See also | ||
|
|
||
| * xref:redpanda-cloud:manage:api/cloud-api-quickstart.adoc[Cloud API Quickstart] | ||
| * xref:redpanda-cloud:manage:api/cloud-api-errors.adoc[Cloud API Error and Status Codes] | ||
| * link:https://docs.redpanda.com/api/cloud-dataplane-api.html[Data Plane API Reference] | ||
|
|
||
|
|
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,4 @@ | ||
| = Data Plane APIs | ||
| :page-api-spec-url: api:ROOT:attachment$cloud-dataplane-api.yaml | ||
| :page-layout: swagger | ||
| :page-try-it: true |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| = OAuth Receiver | ||
| :page-layout: oauth |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,7 @@ | ||
| :page-layout: api-partial | ||
|
|
||
| . To issue requests to the Data Plane APIs from this page, click *Get Token*. | ||
| . If successful, the text “1 API key applied” displays under the *Authentication* header. The token is valid for one hour. | ||
| . Make sure you have set the correct <<servers,API server>> value based on your <<data-plane-api-url,Data Plane API URL>>. | ||
|
|
||
| See xref:redpanda-cloud:manage:api/cloud-api-authentication.adoc[Cloud API Authentication] for more information. |
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,25 @@ | ||
| :page-layout: api-partial | ||
|
|
||
| The Redpanda Cloud Data Plane APIs enable you to programmatically manage the resources within your clusters, including topics, users, access control lists (ACLs), and connectors. | ||
|
|
||
| To familiarize yourself with Redpanda Cloud API basics, see the xref:redpanda-cloud:manage:api/cloud-api-overview.adoc[Redpanda Cloud API Overview]. To get started using the API, try the xref:redpanda-cloud:manage:api/cloud-api-quickstart.adoc[Quickstart]. | ||
|
|
||
| NOTE: Redpanda Cloud uses a control plane and data plane architecture. To see the available endpoints for managing your clusters, networks, and resource groups, see the link:https://docs.redpanda.com/api/cloud-controlplane-api.html[Control Plane API Reference]. | ||
|
|
||
| == Requirements | ||
|
|
||
| To use the Data Plane APIs: | ||
|
|
||
| * You must be a customer with an existing organization in Redpanda Cloud. | ||
| * You can only use one organization for authentication. See xref:redpanda-cloud:manage:api/cloud-api-authentication.adoc[Cloud API Authentication] for steps to authenticate API requests. | ||
|
|
||
| == Data Plane API URL | ||
|
|
||
| The xref:redpanda-cloud:manage:api/cloud-api-overview.adoc#data-plane-apis-url[*base URL*] of the Data Plane APIs is unique to every cluster. You can retrieve this value by making a link:https://docs.redpanda.com/api/cloud-controlplane-api.html#get-/v1beta2/clusters/-id-[Get Cluster] request to your target cluster. Use the `dataplane_api.url` from the response body as the base URL when calling the Data Plane API endpoints. | ||
|
|
||
| == See also | ||
|
|
||
| * xref:redpanda-cloud:manage:api/cloud-api-quickstart.adoc[Cloud API Quickstart] | ||
| * xref:redpanda-cloud:manage:api/cloud-api-errors.adoc[Cloud API Error and Status Codes] | ||
| * link:https://docs.redpanda.com/api/cloud-controlplane-api.html[Control Plane API Reference] | ||
|
|
||
This file was deleted.
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@JakeSCahill I wasn't sure if I was supposed to use the .adoc extension for this link, so I kept it to .html just in case. Let me know if that should be changed