Skip to content

Commit c250d8b

Browse files
kbatuigasmicheleRP
andauthored
Link out to docs in main docs site (#17)
* Link out to docs in main docs site * Apply suggestions from automated review * Update cloud-controlplane/cloud-controlplane.yaml Co-authored-by: Michele Cyran <[email protected]> * For consistency with POST endpoint --------- Co-authored-by: Michele Cyran <[email protected]>
1 parent 17fde8e commit c250d8b

File tree

3 files changed

+38
-2
lines changed

3 files changed

+38
-2
lines changed

cloud-controlplane/cloud-controlplane.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4838,7 +4838,7 @@ paths:
48384838
tags:
48394839
- Serverless Clusters
48404840
post:
4841-
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.
4841+
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}`.
48424842
operationId: ServerlessClusterService_CreateServerlessCluster
48434843
requestBody:
48444844
content:
@@ -4884,7 +4884,7 @@ paths:
48844884
- Serverless Clusters
48854885
/v1/serverless/clusters/{id}:
48864886
delete:
4887-
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.
4887+
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}`.
48884888
operationId: ServerlessClusterService_DeleteServerlessCluster
48894889
parameters:
48904890
- description: ID of Serverless cluster.
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Overlay to add description and external documentation links
2+
# to the HTTP Proxy API specification
3+
overlay: 1.0.0
4+
info:
5+
title: Add External Documentation Links
6+
version: 1.0.0
7+
actions:
8+
# Add enhanced description to the info node
9+
- target: "$.info"
10+
update:
11+
description: |
12+
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.
13+
14+
See also:
15+
16+
- [Use Redpanda Cloud with the HTTP Proxy API](https://docs.redpanda.com/redpanda-cloud/develop/http-proxy/)
17+
- [Use Redpanda Self-Managed with the HTTP Proxy API](https://docs.redpanda.com/current/develop/http-proxy/)
18+
Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
# Overlay to add description and external documentation links
2+
# to the Schema Registry API specification
3+
overlay: 1.0.0
4+
info:
5+
title: Add External Documentation Links
6+
version: 1.0.0
7+
actions:
8+
# Add enhanced description to the info node
9+
- target: "$.info"
10+
update:
11+
description: |
12+
Manage schemas within a Redpanda cluster.
13+
14+
See also:
15+
16+
- [Use Redpanda Cloud with the Schema Registry API](https://docs.redpanda.com/redpanda-cloud/manage/schema-reg/schema-reg-api/)
17+
- [Use Redpanda Self-Managed with the Schema Registry API](https://docs.redpanda.com/current/manage/schema-reg/schema-reg-api/)
18+

0 commit comments

Comments
 (0)