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.

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

Edit data plane API specs #1598

Merged
merged 1 commit into from
Jan 24, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

5 changes: 2 additions & 3 deletions backend/pkg/tools/openapi-generator/main.go
Original file line number Diff line number Diff line change
Expand Up @@ -184,9 +184,8 @@ func updateSecurity(doc3 *openapi3.T) {

func updateInfo(doc3 *openapi3.T) {
doc3.Info = &openapi3.Info{
Title: "Redpanda Cloud",
Description: "Welcome to Redpanda Cloud's Dataplane API documentation.",
Version: "v1alpha2",
Title: "Redpanda Cloud Data Plane API",
Version: "v1alpha2",
}
}

Expand Down
2 changes: 1 addition & 1 deletion proto/gen/openapi/openapi.json

Large diffs are not rendered by default.

7 changes: 3 additions & 4 deletions proto/gen/openapi/openapi.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -1667,8 +1667,7 @@ components:
x-client-id: dQjapNIAHhF7EQqQToRla3yEII9sUSap
type: oauth2
info:
description: Welcome to Redpanda Cloud's Dataplane API documentation.
title: Redpanda Cloud
title: Redpanda Cloud Data Plane API
version: v1alpha2
openapi: 3.0.3
paths:
Expand Down Expand Up @@ -4262,7 +4261,7 @@ paths:
content:
multipart/form-data:
schema:
example: '{"name":"redact-orders","input_topic_name":"orders","output_topic_names":["orders-redacted"],"environment_variables":[{"key":"LOGGER_LEVEL","value":"DEBUG"}]}'
example: '{"name":"redact-orders", "input_topic_name":"orders", "output_topic_names":["orders-redacted"], "environment_variables":[{"key":"LOGGER_LEVEL", "value":"DEBUG"}]}'
properties:
metadata:
$ref: '#/components/schemas/DeployTransformRequest'
Expand Down Expand Up @@ -4666,7 +4665,7 @@ servers:
tags:
- description: Manage Redpanda [access-control lists](https://docs.redpanda.com/current/manage/security/authorization/acl/) (ACLs).
name: Redpanda ACLs
- description: Cloud Storage operations allow you to mange Redpanda topics that are stored in object storage.
- description: 'Manage Redpanda topics stored in object storage. See: [Mountable Topics](https://docs.redpanda.com/redpanda-cloud/manage/mountable-topics/)'
name: Cloud Storage
- description: Manage Wasm transforms in Redpanda.
name: WASM Transforms
Expand Down
2 changes: 1 addition & 1 deletion proto/redpanda/api/dataplane/v1alpha2/cloud_storage.proto
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ message UpdateMountTaskResponse {}
service CloudStorageService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_tag) = {
name: "Cloud Storage"
description: "Cloud Storage operations allow you to mange Redpanda topics that are stored in object storage."
description: "Manage Redpanda topics stored in object storage. See: [Mountable Topics](https://docs.redpanda.com/redpanda-cloud/manage/mountable-topics/)"
};
rpc MountTopics(MountTopicsRequest) returns (MountTopicsResponse) {
option (google.api.http) = {
Expand Down
Loading