Skip to content

Conversation

@vbotbuildovich
Copy link
Contributor

@vbotbuildovich vbotbuildovich commented Feb 25, 2025

This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: 98b31d2e911c5502657e824cb62899c77db78cba

@netlify
Copy link

netlify bot commented Feb 25, 2025

Deploy Preview for redpanda-docs-preview ready!

Name Link
🔨 Latest commit e2fec8d
🔍 Latest deploy log https://app.netlify.com/sites/redpanda-docs-preview/deploys/67dc740b5081810008d13754
😎 Deploy Preview https://deploy-preview-986--redpanda-docs-preview.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@kbatuigas
Copy link
Contributor

Need to confirm with Cloud team regarding these changes

@vbotbuildovich vbotbuildovich force-pushed the update-branch-api branch 5 times, most recently from 9422b96 to 395548c Compare March 6, 2025 15:42
@kbatuigas
Copy link
Contributor

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).

@vbotbuildovich vbotbuildovich force-pushed the update-branch-api branch 2 times, most recently from b500386 to 7cc45e4 Compare March 10, 2025 19:10
Copy link
Contributor

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 v1 and 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.

@kbatuigas
Copy link
Contributor

kbatuigas commented Mar 11, 2025

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.

Copy link
Contributor

@Feediver1 Feediver1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

lgtm

@kbatuigas
Copy link
Contributor

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.

@vbotbuildovich vbotbuildovich force-pushed the update-branch-api branch 3 times, most recently from cd3591b to f069794 Compare March 19, 2025 21:00
@kbatuigas
Copy link
Contributor

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 🙏

@bojand
Copy link
Contributor

bojand commented Mar 20, 2025

https://prod-cloudv2.us.auth0.com/oauth/authorize is actually correct. But there is another cloudv2 PR https://github.com/redpanda-data/cloudv2/pull/21599 incoming that should update docs to more recent correct state.

Co-authored-by: Joyce Fee <102751339+Feediver1@users.noreply.github.com>
@kbatuigas kbatuigas merged commit 621111f into api Mar 20, 2025
5 checks passed
@kbatuigas kbatuigas deleted the update-branch-api branch March 20, 2025 20:06
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants