Skip to content
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
4 changes: 2 additions & 2 deletions cloud-controlplane/cloud-controlplane.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -4838,7 +4838,7 @@ paths:
tags:
- Serverless Clusters
post:
description: Create a Redpanda Serverless cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state.
description: Create a Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`.
operationId: ServerlessClusterService_CreateServerlessCluster
requestBody:
content:
Expand Down Expand Up @@ -4884,7 +4884,7 @@ paths:
- Serverless Clusters
/v1/serverless/clusters/{id}:
delete:
description: Delete Redpanda Serverless cluster. Returns a long-running operation. See [Use the Control Plane API](https://docs.redpanda.com/redpanda-cloud/manage/api/controlplane/) for more information. Call `GET /v1/operations/{id}` to check operation state.
description: Delete Redpanda Serverless cluster. Returns a long-running operation. For more information, see [Use the Control Plane API with Serverless](https://docs.redpanda.com/redpanda-cloud/manage/api/cloud-serverless-controlplane-api/). To check operation state, call `GET /v1/operations/{id}`.
operationId: ServerlessClusterService_DeleteServerlessCluster
parameters:
- description: ID of Serverless cluster.
Expand Down
18 changes: 18 additions & 0 deletions http-proxy/overlays/add-external-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Overlay to add description and external documentation links
# to the HTTP Proxy API specification
overlay: 1.0.0
info:
title: Add External Documentation Links
version: 1.0.0
actions:
# Add enhanced description to the info node
- target: "$.info"
update:
description: |
HTTP Proxy is an HTTP server that exposes operations you can perform directly on a Redpanda cluster. Use the Redpanda HTTP Proxy API to perform a subset of actions that are also available through the Kafka API, but using simpler REST operations.

See also:

- [Use Redpanda Cloud with the HTTP Proxy API](https://docs.redpanda.com/redpanda-cloud/develop/http-proxy/)
- [Use Redpanda Self-Managed with the HTTP Proxy API](https://docs.redpanda.com/current/develop/http-proxy/)

18 changes: 18 additions & 0 deletions schema-registry/overlays/add-external-docs.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,18 @@
# Overlay to add description and external documentation links
# to the Schema Registry API specification
overlay: 1.0.0
info:
title: Add External Documentation Links
version: 1.0.0
actions:
# Add enhanced description to the info node
- target: "$.info"
update:
description: |
Manage schemas within a Redpanda cluster.

See also:

- [Use Redpanda Cloud with the Schema Registry API](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-api/)
- [Use Redpanda Self-Managed with the Schema Registry API](https://docs.redpanda.com/current/manage/schema-reg/schema-reg-api/)