Skip to content
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.

Sign up for GitHub

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

Update openapi spec - servers description #1575

Open
wants to merge 3 commits into
base: master
Choose a base branch
from
Open

Update openapi spec - servers description #1575

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
e217537
Update servers description
kbatuigas Jan 6, 2025
169190e
Change default server URL
kbatuigas Jan 6, 2025
18d24fa
Run proto:generate and make sure spec files are not deleted
kbatuigas Jan 7, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 5 additions & 7 deletions backend/pkg/tools/openapi-generator/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -142,15 +142,13 @@ func updateServers(doc3 *openapi3.T) {
doc3.Servers = []*openapi3.Server{
{
URL: "{dataplane_api_url}",
Description: "Dataplane API",
Description: "Data Plane API",
Variables: map[string]*openapi3.ServerVariable{
"dataplane_api_url": {
Default: "https://api-a4cb21.ck09ma3c4vs12cng3cig.fmc.prd.cloud.redpanda.com",
Description: `Dataplane API.<br>
The Dataplane API allows management of Topics,ACLs,Service accounts. It is exposed by each individual cluster.
Retrieve the Dataplane API URL of a cluster by using the dataplane_api.url field returned by the Get Cluster endpoint.<br><br>
Example (Dedicated): https://api-a4cb21.ck09mi9c4vs17hng9gig.fmc.prd.cloud.redpanda.com<br>
Example (BYOC): https://api-a4cb21.ck09mi9c4vs17hng9gig.byoc.prd.cloud.redpanda.com`,
Default: "https://{dataplane_api_url}",
Description: `Find the Data Plane API base URL of a cluster by calling the Get Cluster endpoint of the Control Plane API. The dataplane_api.url field is returned in the response body.<br><br>
Example (Dedicated): "https://api-a4cb21.ck09mi9c4vs17hng9gig.fmc.prd.cloud.redpanda.com"<br>
Example (BYOC): "https://api-a4cb21.ck09mi9c4vs17hng9gig.byoc.prd.cloud.redpanda.com"`,
},
},
},
Expand Down
2 changes: 1 addition & 1 deletion proto/gen/openapi/openapi.json
View file
Open in desktop

Large diffs are not rendered by default.

12 changes: 5 additions & 7 deletions proto/gen/openapi/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4644,17 +4644,15 @@ paths:
security:
- auth0: []
servers:
- description: Dataplane API
- description: Data Plane API
url: '{dataplane_api_url}'
variables:
dataplane_api_url:
default: https://api-a4cb21.ck09ma3c4vs12cng3cig.fmc.prd.cloud.redpanda.com
default: https://{dataplane_api_url}
description: |-
Dataplane API.<br>
The Dataplane API allows management of Topics,ACLs,Service accounts. It is exposed by each individual cluster.
Retrieve the Dataplane API URL of a cluster by using the dataplane_api.url field returned by the Get Cluster endpoint.<br><br>
Example (Dedicated): https://api-a4cb21.ck09mi9c4vs17hng9gig.fmc.prd.cloud.redpanda.com<br>
Example (BYOC): https://api-a4cb21.ck09mi9c4vs17hng9gig.byoc.prd.cloud.redpanda.com
Find the Data Plane API base URL of a cluster by calling the Get Cluster endpoint of the Control Plane API. The dataplane_api.url field is returned in the response body.<br><br>
Example (Dedicated): "https://api-a4cb21.ck09mi9c4vs17hng9gig.fmc.prd.cloud.redpanda.com"<br>
Example (BYOC): "https://api-a4cb21.ck09mi9c4vs17hng9gig.byoc.prd.cloud.redpanda.com"
tags:
- description: Manage Redpanda [access-control lists](https://docs.redpanda.com/beta/manage/security/authorization/acl/) (ACLs).
name: ACLService
Expand Down
Loading