diff --git a/cloud-controlplane/cloud-controlplane.yaml b/cloud-controlplane/cloud-controlplane.yaml index 7c29b45..da8e725 100644 --- a/cloud-controlplane/cloud-controlplane.yaml +++ b/cloud-controlplane/cloud-controlplane.yaml @@ -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: @@ -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. diff --git a/http-proxy/overlays/add-external-docs.yaml b/http-proxy/overlays/add-external-docs.yaml new file mode 100644 index 0000000..225e29f --- /dev/null +++ b/http-proxy/overlays/add-external-docs.yaml @@ -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/) + \ No newline at end of file diff --git a/schema-registry/overlays/add-external-docs.yaml b/schema-registry/overlays/add-external-docs.yaml new file mode 100644 index 0000000..145f41e --- /dev/null +++ b/schema-registry/overlays/add-external-docs.yaml @@ -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/) + \ No newline at end of file