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

docs: update dependency and generate better tags #1587

Merged
merged 1 commit into from
Jan 16, 2025

Conversation

sago2k8
Copy link
Contributor

@sago2k8 sago2k8 commented Jan 15, 2025

Generate better tags for the services, in order to do so updating the grpc-gateway dependency was necessary

Copy link

github-actions bot commented Jan 15, 2025

The latest Buf updates on your PR. Results from workflow Buf CI / push-module (pull_request).

BuildFormatLintBreakingUpdated (UTC)
✅ passed✅ passed✅ passed✅ passedJan 16, 2025, 3:39 PM

@bojand bojand self-requested a review January 15, 2025 15:36
@sago2k8 sago2k8 force-pushed the sj/docs/openapi-docs branch from 1ebe5e3 to 7cdc156 Compare January 16, 2025 10:14
@@ -189,6 +189,10 @@ message UpdateMountTaskResponse {}
// CloudStorageService implements endpoints for mounting and unmounting topics in Redpanda clusters.
// Requires that you have tiered storage enabled.
service CloudStorageService {
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_tag) = {
name: "Cloud Storage"
description: "Cloud Storage operations allow you mange Redpanda topics that are stored in object storage."
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: "Cloud Storage operations allow you mange Redpanda topics that are stored in object storage."
description: "Cloud Storage operations allow you to manage Redpanda topics that are stored in object storage."

option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_tag) = {description: "Manage [connectors](https://docs.redpanda.com/current/deploy/deployment-option/cloud/managed-connectors/) and interact with the Kafka Connect API."};
option (grpc.gateway.protoc_gen_openapiv2.options.openapiv2_tag) = {
name: "Kafka Connect"
description: "Manage [connectors](https://docs.redpanda.com/redpanda-cloud/develop/managed-connectors//) and interact with the Kafka Connect API."
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
description: "Manage [connectors](https://docs.redpanda.com/redpanda-cloud/develop/managed-connectors//) and interact with the Kafka Connect API."
description: "Manage [connectors](https://docs.redpanda.com/redpanda-cloud/develop/managed-connectors/) and interact with the Kafka Connect API."

Generate better tags for the services, in order to do so updating the
grpc-gateway dependency was necessary

Signed-off-by: Santiago Jimenez Giraldo <[email protected]>
@sago2k8 sago2k8 force-pushed the sj/docs/openapi-docs branch from 7cdc156 to 9ca8318 Compare January 16, 2025 15:39
@sago2k8 sago2k8 merged commit 19fe8d8 into master Jan 16, 2025
5 checks passed
@sago2k8 sago2k8 deleted the sj/docs/openapi-docs branch January 16, 2025 15:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants