auto-docs: Update Cloud API spec #986
Conversation
✅ Deploy Preview for redpanda-docs-preview ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
vbotbuildovich
force-pushed
the
update-branch-api
branch
from
7163be5 to
e146db7
Compare
|
Need to confirm with Cloud team regarding these changes |
vbotbuildovich
force-pushed
the
update-branch-api
branch
5 times, most recently
from
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). |
vbotbuildovich
force-pushed
the
update-branch-api
branch
2 times, most recently
from
b500386 to
7cc45e4
Compare
There was a problem hiding this comment.
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.
vbotbuildovich
force-pushed
the
update-branch-api
branch
from
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. |
vbotbuildovich
force-pushed
the
update-branch-api
branch
from
335b5f3 to
082237e
Compare
| @@ -1117,6 +1117,11 @@ components: | |||
| $ref: '#/components/schemas/Pipeline.State' | |||
| status: | |||
| $ref: '#/components/schemas/Pipeline.Status' | |||
| url: | |||
| description: |- | |||
| URL to connect to the pipeline, e.g. via http_server. | |||
There was a problem hiding this comment.
| URL to connect to the pipeline, e.g. via http_server. | |
| URL to connect to the pipeline, for example, using http_server. |
|
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
force-pushed
the
update-branch-api
branch
from
082237e to
d2633e9
Compare
This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: 5c94992f5631fb12161c2529ee28288853b7e2fe