Skip to content

[v25.3.x] Improve descriptions for OpenAPI (backport) #29275

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

Merged
kbatuigas merged 2 commits into from
Jan 15, 2026
Merged

[v25.3.x] Improve descriptions for OpenAPI (backport) #29275

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
abc4072
proto: improve summaries and descriptions for OpenAPI docs
kbatuigas Dec 17, 2025
e2861b9
Fix CI error
kbatuigas Jan 15, 2026
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
8 changes: 6 additions & 2 deletions proto/redpanda/core/admin/v2/broker.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,17 @@ option (pbgen.cpp_namespace) = "proto::admin";
// The BrokerService gives information about individual brokers within the
// cluster.
service BrokerService {
// GetBroker returns information about a single broker in the cluster.
// GetBroker
//
// Returns information about a single broker in the cluster.
rpc GetBroker(GetBrokerRequest) returns (GetBrokerResponse) {
option (pbgen.rpc) = {
authz: SUPERUSER
};
}
// ListBrokers returns information about all brokers in the cluster.
// ListBrokers
//
// Returns information about all brokers in the cluster.
rpc ListBrokers(ListBrokersRequest) returns (ListBrokersResponse) {
option (pbgen.rpc) = {
authz: SUPERUSER
Expand Down
6 changes: 4 additions & 2 deletions proto/redpanda/core/admin/v2/cluster.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,8 +24,10 @@ option (pbgen.cpp_namespace) = "proto::admin";

// The ClusterService gives information about the cluster.
service ClusterService {
// ListKafkaConnections returns information about the cluster's Kafka
// connections, collected and ordered across all brokers.
// ListKafkaConnections
//
// Returns information about the cluster's Kafka connections, collected
// and ordered across all brokers.
rpc ListKafkaConnections(ListKafkaConnectionsRequest)
returns (ListKafkaConnectionsResponse) {
option (pbgen.rpc) = {
Expand Down
33 changes: 27 additions & 6 deletions proto/redpanda/core/admin/v2/shadow_link.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,53 +30,74 @@ import "google/protobuf/field_mask.proto";
option (pbgen.cpp_namespace) = "proto::admin";

service ShadowLinkService {
// CreateShadowLink
//
// Creates a new shadow link between clusters.
rpc CreateShadowLink(CreateShadowLinkRequest)
returns (CreateShadowLinkResponse) {
option (pbgen.rpc) = {
authz: SUPERUSER
};
}
// DeleteShadowLink
//
// Deletes an existing shadow link.
rpc DeleteShadowLink(DeleteShadowLinkRequest)
returns (DeleteShadowLinkResponse) {
option (pbgen.rpc) = {
authz: SUPERUSER
};
}
// GetShadowLink
//
// Gets information about a specific shadow link.
rpc GetShadowLink(GetShadowLinkRequest) returns (GetShadowLinkResponse) {
option (pbgen.rpc) = {
authz: SUPERUSER
};
}
// ListShadowLinks
//
// Lists all shadow links in the cluster.
rpc ListShadowLinks(ListShadowLinksRequest)
returns (ListShadowLinksResponse) {
option (pbgen.rpc) = {
authz: SUPERUSER
};
}
// UpdateShadowLink
//
// Updates an existing shadow link configuration.
rpc UpdateShadowLink(UpdateShadowLinkRequest)
returns (UpdateShadowLinkResponse) {
option (pbgen.rpc) = {
authz: SUPERUSER
};
}
// Fails over a shadow link or a single shadow topic
// FailOver
//
// Fails over a shadow link or a single shadow topic for disaster recovery.
rpc FailOver(FailOverRequest) returns (FailOverResponse) {
option (pbgen.rpc) = {
authz: SUPERUSER
};
}

// This operation returns information about a Shadow Topic on a Shadow Link.
// A Shadow Topic is a resource created automatically by a Shadow Link. The
// Shadow Topic 'shadows' a topic on a source cluster, mirroring the data
// GetShadowTopic
//
// Returns information about a shadow topic on a shadow link.
// A shadow topic is a resource created automatically by a shadow link. The
// shadow topic 'shadows' a topic on a source cluster, mirroring the data
// and properties of that topic.
rpc GetShadowTopic(GetShadowTopicRequest) returns (GetShadowTopicResponse) {
option (pbgen.rpc) = {
authz: SUPERUSER
};
}
// This operation returns a list of all Shadow Topics on a Shadow Link and
// their status
// ListShadowTopics
//
// Returns a list of all shadow topics on a shadow link and
// their status.
rpc ListShadowTopics(ListShadowTopicsRequest)
returns (ListShadowTopicsResponse) {
option (pbgen.rpc) = {
Expand Down
Loading