-
Notifications
You must be signed in to change notification settings - Fork 47
auto-docs: Update Cloud API spec #986
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
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
7163be5 to
e146db7
Compare
|
Need to confirm with Cloud team regarding these changes |
9422b96 to
395548c
Compare
|
Working with API team to make sure data plane specs are up to date and correct for v1, and that there is a way to group/separate out control plane v1beta2 (in the absence of versioned API docs). |
b500386 to
7cc45e4
Compare
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.
Status update:
- no blockers on the control plane side
- spoke with @bojand and v1 for data plane was merged in Console today, and the next release is scheduled for next Monday the 17th. That should get v1 data plane integrated into Cloud, which should bring in the correct updates for the data plane API specs via GH Actions (update the endpoint paths to
v1and remove the unwanted changes to the fields specified in this current diff). - We also talked about grouping the v1 and v1alpha2 tags in the same way as in the Control Plane, which is the quickest and easiest way to denote which endpoints belong to each respective version in the absence of versioned API docs. I plan to open a PR in Console to update the tag names.
7cc45e4 to
335b5f3
Compare
|
Status update: Per today's Cloud API sync, we will modify the control plane and data plane OpenAPI files so that they contain only v1 endpoints. Awaiting this change from Engineering/cloudv2. When we get the files in this import, we can merge this PR and redpanda-data/cloud-docs#211 as well. |
335b5f3 to
082237e
Compare
Feediver1
left a comment
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.
lgtm
|
Status update: Data plane all set, awaiting updated v1-only specs for control plane which should come within this week. redpanda-data/cloud-docs#211 is ready once all updated specs are merged. |
cd3591b to
f069794
Compare
|
Status update: Still awaiting fixes to DP (recent cloudv2 update pushed unwanted changes again) and CP specs. Those PRs are actively being worked on at the moment. This will be a blocker for a new doc update for RPCN in GCP BYOVPC (going out possibly some time next week) as that will have to link to the API reference doc, so we need the updated specs before then, ideally by tomorrow at the latest. cc @sago2k8 @bojand 🙏 |
|
|
f069794 to
b8a8ed0
Compare
b8a8ed0 to
a73404f
Compare
Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: 98b31d2e911c5502657e824cb62899c77db78cba