From 59a5bbdcd6b7e250f2ecedbd0a5eaf8f7785fe3a Mon Sep 17 00:00:00 2001 From: Kat Batuigas <36839689+kbatuigas@users.noreply.github.com> Date: Wed, 13 Aug 2025 18:32:41 -0700 Subject: [PATCH 01/17] Fix link --- cloud-controlplane/x-topics/quickstart.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/cloud-controlplane/x-topics/quickstart.md b/cloud-controlplane/x-topics/quickstart.md index a37b6cb..14e3c43 100644 --- a/cloud-controlplane/x-topics/quickstart.md +++ b/cloud-controlplane/x-topics/quickstart.md @@ -91,10 +91,10 @@ If you successfully retrieve an access token, it is valid for one hour. You can 1. Select an operation, for example **Create topic** or **List users**. 1. In the URL field, add the data plane API URL. You can now make Data Plane API requests to your target cluster. -See also: [Data Plane API Quickstart](/cloud-dataplane/topic/topic-quickstart) +See also: [Data Plane API Quickstart](/api/doc/cloud-dataplane/topic/topic-quickstart) ## Suggested reading - Learn about Redpanda Cloud [network security and connectivity](https://docs.redpanda.com/redpanda-cloud/networking/) for BYOC and Dedicated clusters. - Manage [authentication and authorization](https://docs.redpanda.com/redpanda-cloud/security/authorization/) in Redpanda Cloud. -- [Create a Kafka client or generate a sample application](https://docs.redpanda.com/redpanda-cloud/get-started/cluster-types/serverless/#connect-with-your-cluster) to interact with your Serverless cluster. \ No newline at end of file +- [Create a Kafka client or generate a sample application](https://docs.redpanda.com/redpanda-cloud/get-started/cluster-types/serverless/#connect-with-your-cluster) to interact with your Serverless cluster. From b720fbc339b059241e7d4bb4ad2fba9b2539f181 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Fri, 15 Aug 2025 09:56:49 -0700 Subject: [PATCH 02/17] Use overlays to add feedback links to docs --- shared/overlays/cloud-add-feedback-link.yaml | 15 +++++++++++++++ shared/overlays/sm-add-feedback-link.yaml | 15 +++++++++++++++ 2 files changed, 30 insertions(+) create mode 100644 shared/overlays/cloud-add-feedback-link.yaml create mode 100644 shared/overlays/sm-add-feedback-link.yaml diff --git a/shared/overlays/cloud-add-feedback-link.yaml b/shared/overlays/cloud-add-feedback-link.yaml new file mode 100644 index 0000000..f863ff6 --- /dev/null +++ b/shared/overlays/cloud-add-feedback-link.yaml @@ -0,0 +1,15 @@ +# Overlay to add feedback link to the API specification +# This adds a feedback button in the Control Plane and Data Plane API docs +# for users to report issues through GitHub + +overlay: 1.0.0 +info: + title: Add Feedback Link + version: 1.0.0 +actions: + # Add x-feedbackLink to the top-level info element + - target: "$.info" + update: + x-feedbackLink: + label: "Documentation update request" + url: "https://github.com/redpanda-data/cloud-docs/issues/new?template=01_doc_request.yml" diff --git a/shared/overlays/sm-add-feedback-link.yaml b/shared/overlays/sm-add-feedback-link.yaml new file mode 100644 index 0000000..f4562c4 --- /dev/null +++ b/shared/overlays/sm-add-feedback-link.yaml @@ -0,0 +1,15 @@ +# Overlay to add feedback link to the API specification +# This adds a feedback button in the HTTP Proxy, Schema Registry, and Admin API docs +# for users to report issues through GitHub + +overlay: 1.0.0 +info: + title: Add Feedback Link + version: 1.0.0 +actions: + # Add x-feedbackLink to the top-level info element + - target: "$.info" + update: + x-feedbackLink: + label: "Documentation update request" + url: "https://github.com/redpanda-data/cloud-docs/issues/new?template=01_doc_request.yml" From f4696ca8794bb3b00c51a7afc4acb1d551c32fe5 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Fri, 15 Aug 2025 12:01:17 -0700 Subject: [PATCH 03/17] Use correct GitHub URL --- shared/overlays/sm-add-feedback-link.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/shared/overlays/sm-add-feedback-link.yaml b/shared/overlays/sm-add-feedback-link.yaml index f4562c4..4adde44 100644 --- a/shared/overlays/sm-add-feedback-link.yaml +++ b/shared/overlays/sm-add-feedback-link.yaml @@ -12,4 +12,4 @@ actions: update: x-feedbackLink: label: "Documentation update request" - url: "https://github.com/redpanda-data/cloud-docs/issues/new?template=01_doc_request.yml" + url: "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" From f187e36c3c2c0d8b3907f215c2839c165ed4e81d Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 Aug 2025 10:28:33 +0100 Subject: [PATCH 04/17] Allow for shared self-managed overlays --- .github/workflows/bump.yml | 91 ++++++++----------- cloud-controlplane/overlays/add-x-topics.yaml | 2 +- cloud-dataplane/overlays/add-x-topics.yaml | 2 +- ...e-securityschemes-for-authentication.yaml} | 0 ...ation.md => cloud-about-authentication.md} | 0 5 files changed, 38 insertions(+), 57 deletions(-) rename shared/overlays/{update-securityschemes-for-authentication.yaml => cloud-update-securityschemes-for-authentication.yaml} (100%) rename shared/x-topics/{about-authentication.md => cloud-about-authentication.md} (100%) diff --git a/.github/workflows/bump.yml b/.github/workflows/bump.yml index 5fd9bfa..651831a 100644 --- a/.github/workflows/bump.yml +++ b/.github/workflows/bump.yml @@ -40,41 +40,22 @@ jobs: id: set-matrix run: | DOCS=() - - # Check for changes in API doc folders - if echo "$CHANGED_FILES" | grep -q "^admin/"; then - DOCS+=("admin") - fi - if echo "$CHANGED_FILES" | grep -q "^cloud-controlplane/"; then - DOCS+=("cloud-controlplane") - fi - if echo "$CHANGED_FILES" | grep -q "^cloud-dataplane/"; then - DOCS+=("cloud-dataplane") - fi - if echo "$CHANGED_FILES" | grep -q "^schema-registry/"; then - DOCS+=("schema-registry") - fi - if echo "$CHANGED_FILES" | grep -q "^http-proxy/"; then - DOCS+=("http-proxy") - fi - # Check for changes in shared resources that might affect all docs - if echo "$CHANGED_FILES" | grep -q "^shared/"; then - if [ ${#DOCS[@]} -eq 0 ]; then - # If only shared files changed and no specific doc files, include all docs - DOCS+=("admin" "cloud-controlplane" "cloud-dataplane" "schema-registry" "http-proxy") + for d in */ ; do + # Exclude shared and .github or any other non-doc folders + if [[ "$d" != "shared/" && "$d" != ".github/" && ( -f "${d%/}/${d%/}.yaml" || -f "${d%/}/${d%/}.json" ) ]]; then + DOCS+=("${d%/}") fi - fi + done - # If no files changed in any monitored directories, abort the workflow + # If no doc folders found, abort the workflow if [ ${#DOCS[@]} -eq 0 ]; then - echo "No relevant files were changed. Exiting workflow." + echo "No doc folders found. Exiting workflow." echo "matrix={\"doc_id\":[]}" >> $GITHUB_OUTPUT exit 0 fi - # Convert bash array to JSON array for GitHub Actions matrix JSON_ARRAY=$(printf '"%s",' "${DOCS[@]}" | sed 's/,$//') - JSON_MATRIX="{\"doc_id\":[$JSON_ARRAY]}" + JSON_MATRIX="{\"doc_id\":[${JSON_ARRAY}]}" echo "matrix=$JSON_MATRIX" >> $GITHUB_OUTPUT echo "Created matrix: $JSON_MATRIX" @@ -107,28 +88,27 @@ jobs: run: | OVERLAYS="" - # Check for doc-specific overlays + # Add doc-specific overlays (if any) if [ -d "${{ matrix.doc_id }}/overlays" ]; then for overlay_file in "${{ matrix.doc_id }}/overlays"/*.yaml; do if [ -f "$overlay_file" ]; then - if [ -n "$OVERLAYS" ]; then - OVERLAYS="$OVERLAYS,$overlay_file" - else - OVERLAYS="$overlay_file" - fi + OVERLAYS="${OVERLAYS:+$OVERLAYS,}$overlay_file" fi done fi - # Check for shared overlays - only apply to cloud APIs - if [[ "${{ matrix.doc_id }}" == "cloud-"* ]] && [ -d "shared/overlays" ]; then - for overlay_file in shared/overlays/*.yaml; do + # Determine shared overlay prefix + if [[ "${{ matrix.doc_id }}" == "cloud-"* ]]; then + OVERLAY_PREFIX="cloud-" + else + OVERLAY_PREFIX="sm-" + fi + + # Add matching shared overlays + if [ -d "shared/overlays" ]; then + for overlay_file in shared/overlays/${OVERLAY_PREFIX}*.yaml; do if [ -f "$overlay_file" ]; then - if [ -n "$OVERLAYS" ]; then - OVERLAYS="$OVERLAYS,$overlay_file" - else - OVERLAYS="$overlay_file" - fi + OVERLAYS="${OVERLAYS:+$OVERLAYS,}$overlay_file" fi done fi @@ -136,6 +116,7 @@ jobs: echo "overlay_paths=$OVERLAYS" >> $GITHUB_OUTPUT echo "Using overlays: $OVERLAYS" + - name: Deploy API documentation uses: bump-sh/github-action@v1 with: @@ -178,28 +159,27 @@ jobs: run: | OVERLAYS="" - # Check for doc-specific overlays + # Add doc-specific overlays (if any) if [ -d "${{ matrix.doc_id }}/overlays" ]; then for overlay_file in "${{ matrix.doc_id }}/overlays"/*.yaml; do if [ -f "$overlay_file" ]; then - if [ -n "$OVERLAYS" ]; then - OVERLAYS="$OVERLAYS,$overlay_file" - else - OVERLAYS="$overlay_file" - fi + OVERLAYS="${OVERLAYS:+$OVERLAYS,}$overlay_file" fi done fi - # Check for shared overlays - only apply to cloud APIs - if [[ "${{ matrix.doc_id }}" == "cloud-"* ]] && [ -d "shared/overlays" ]; then - for overlay_file in shared/overlays/*.yaml; do + # Determine shared overlay prefix + if [[ "${{ matrix.doc_id }}" == "cloud-"* ]]; then + OVERLAY_PREFIX="cloud-" + else + OVERLAY_PREFIX="sm-" + fi + + # Add matching shared overlays + if [ -d "shared/overlays" ]; then + for overlay_file in shared/overlays/${OVERLAY_PREFIX}*.yaml; do if [ -f "$overlay_file" ]; then - if [ -n "$OVERLAYS" ]; then - OVERLAYS="$OVERLAYS,$overlay_file" - else - OVERLAYS="$overlay_file" - fi + OVERLAYS="${OVERLAYS:+$OVERLAYS,}$overlay_file" fi done fi @@ -207,6 +187,7 @@ jobs: echo "overlay_paths=$OVERLAYS" >> $GITHUB_OUTPUT echo "Using overlays: $OVERLAYS" + - name: Comment pull request with API diff uses: bump-sh/github-action@v1 with: diff --git a/cloud-controlplane/overlays/add-x-topics.yaml b/cloud-controlplane/overlays/add-x-topics.yaml index f66b445..6670b66 100644 --- a/cloud-controlplane/overlays/add-x-topics.yaml +++ b/cloud-controlplane/overlays/add-x-topics.yaml @@ -17,7 +17,7 @@ actions: $ref: ../../shared/x-topics/cloud-api-overview.md - title: Authentication content: - $ref: ../../shared/x-topics/about-authentication.md + $ref: ../../shared/x-topics/cloud-about-authentication.md - title: Regions and Usage Tiers content: $ref: ../x-topics/cloud-regions.md diff --git a/cloud-dataplane/overlays/add-x-topics.yaml b/cloud-dataplane/overlays/add-x-topics.yaml index ae8ea16..e489f49 100644 --- a/cloud-dataplane/overlays/add-x-topics.yaml +++ b/cloud-dataplane/overlays/add-x-topics.yaml @@ -17,7 +17,7 @@ actions: $ref: ../../shared/x-topics/cloud-api-overview.md - title: Authentication content: - $ref: ../../shared/x-topics/about-authentication.md + $ref: ../../shared/x-topics/cloud-about-authentication.md - title: Error and Status Codes content: $ref: ../x-topics/error-and-status-codes.md diff --git a/shared/overlays/update-securityschemes-for-authentication.yaml b/shared/overlays/cloud-update-securityschemes-for-authentication.yaml similarity index 100% rename from shared/overlays/update-securityschemes-for-authentication.yaml rename to shared/overlays/cloud-update-securityschemes-for-authentication.yaml diff --git a/shared/x-topics/about-authentication.md b/shared/x-topics/cloud-about-authentication.md similarity index 100% rename from shared/x-topics/about-authentication.md rename to shared/x-topics/cloud-about-authentication.md From 222ffc4ad35a48de82c235870edf680a4b04a6bc Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 Aug 2025 10:35:03 +0100 Subject: [PATCH 05/17] Check for non-existent files --- .github/workflows/bump.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/bump.yml b/.github/workflows/bump.yml index 651831a..66a99ce 100644 --- a/.github/workflows/bump.yml +++ b/.github/workflows/bump.yml @@ -90,11 +90,13 @@ jobs: # Add doc-specific overlays (if any) if [ -d "${{ matrix.doc_id }}/overlays" ]; then + shopt -s nullglob for overlay_file in "${{ matrix.doc_id }}/overlays"/*.yaml; do if [ -f "$overlay_file" ]; then OVERLAYS="${OVERLAYS:+$OVERLAYS,}$overlay_file" fi done + shopt -u nullglob fi # Determine shared overlay prefix @@ -106,11 +108,13 @@ jobs: # Add matching shared overlays if [ -d "shared/overlays" ]; then + shopt -s nullglob for overlay_file in shared/overlays/${OVERLAY_PREFIX}*.yaml; do if [ -f "$overlay_file" ]; then OVERLAYS="${OVERLAYS:+$OVERLAYS,}$overlay_file" fi done + shopt -u nullglob fi echo "overlay_paths=$OVERLAYS" >> $GITHUB_OUTPUT From 8679c725eef4c0188035ad2962a9df98efa47124 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 Aug 2025 10:37:19 +0100 Subject: [PATCH 06/17] Check for non-existent files --- .github/workflows/bump.yml | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.github/workflows/bump.yml b/.github/workflows/bump.yml index 66a99ce..d73b806 100644 --- a/.github/workflows/bump.yml +++ b/.github/workflows/bump.yml @@ -165,11 +165,13 @@ jobs: # Add doc-specific overlays (if any) if [ -d "${{ matrix.doc_id }}/overlays" ]; then + shopt -s nullglob for overlay_file in "${{ matrix.doc_id }}/overlays"/*.yaml; do if [ -f "$overlay_file" ]; then OVERLAYS="${OVERLAYS:+$OVERLAYS,}$overlay_file" fi done + shopt -u nullglob fi # Determine shared overlay prefix @@ -181,11 +183,13 @@ jobs: # Add matching shared overlays if [ -d "shared/overlays" ]; then + shopt -s nullglob for overlay_file in shared/overlays/${OVERLAY_PREFIX}*.yaml; do if [ -f "$overlay_file" ]; then OVERLAYS="${OVERLAYS:+$OVERLAYS,}$overlay_file" fi done + shopt -u nullglob fi echo "overlay_paths=$OVERLAYS" >> $GITHUB_OUTPUT From 7d9fb218f1ebcfcd83ca5eec770bfc4360299c5f Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 Aug 2025 10:47:05 +0100 Subject: [PATCH 07/17] Test diff --- .github/workflows/bump.yml | 12 ------------ cloud-controlplane/cloud-controlplane.yaml | 2 +- http-proxy/http-proxy.json | 2 +- 3 files changed, 2 insertions(+), 14 deletions(-) diff --git a/.github/workflows/bump.yml b/.github/workflows/bump.yml index d73b806..2a77731 100644 --- a/.github/workflows/bump.yml +++ b/.github/workflows/bump.yml @@ -24,18 +24,6 @@ jobs: with: fetch-depth: 0 - - name: Get changed files - id: changed-files - run: | - if [[ "${{ github.event_name }}" == "pull_request" ]]; then - CHANGED_FILES=$(git diff --name-only ${{ github.event.pull_request.base.sha }} ${{ github.event.pull_request.head.sha }}) - else - CHANGED_FILES=$(git diff --name-only ${{ github.event.before }} ${{ github.event.after }}) - fi - echo "CHANGED_FILES<> $GITHUB_ENV - echo "$CHANGED_FILES" >> $GITHUB_ENV - echo "EOF" >> $GITHUB_ENV - - name: Set matrix id: set-matrix run: | diff --git a/cloud-controlplane/cloud-controlplane.yaml b/cloud-controlplane/cloud-controlplane.yaml index da8e725..3442369 100644 --- a/cloud-controlplane/cloud-controlplane.yaml +++ b/cloud-controlplane/cloud-controlplane.yaml @@ -1,7 +1,7 @@ components: schemas: AWS.Role: - description: Role identifies AWS role. + description: test diff Role identifies AWS role. properties: arn: description: AWS role ARN. diff --git a/http-proxy/http-proxy.json b/http-proxy/http-proxy.json index 470a40f..d9ce539 100644 --- a/http-proxy/http-proxy.json +++ b/http-proxy/http-proxy.json @@ -11,7 +11,7 @@ ], "paths": {"/brokers": { "get": { - "summary": "Get a list of brokers.", + "summary": "test diff Get a list of brokers.", "operationId": "get_brokers", "produces": ["application/vnd.kafka.v2+json"], "responses": { From 3183c7dbd52a24d9c9fd4bc22220dc70e6acb3b2 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 Aug 2025 11:38:13 +0100 Subject: [PATCH 08/17] Test overlays --- .github/workflows/bump.yml | 2 +- .../overlays/add-feedback-link.yaml | 0 http-proxy/overlays/add-external-docs.yaml | 3 +++ schema-registry/overlays/add-external-docs.yaml | 3 +++ 4 files changed, 7 insertions(+), 1 deletion(-) rename shared/overlays/sm-add-feedback-link.yaml => admin/overlays/add-feedback-link.yaml (100%) diff --git a/.github/workflows/bump.yml b/.github/workflows/bump.yml index 2a77731..f63fb8b 100644 --- a/.github/workflows/bump.yml +++ b/.github/workflows/bump.yml @@ -123,7 +123,7 @@ jobs: api-diff: if: ${{ github.event_name == 'pull_request' && fromJson(needs.determine-doc-ids.outputs.matrix).doc_id[0] != null }} needs: determine-doc-ids - name: Check API diff on Bump.sh + name: Check diff runs-on: ubuntu-latest strategy: matrix: ${{fromJson(needs.determine-doc-ids.outputs.matrix)}} diff --git a/shared/overlays/sm-add-feedback-link.yaml b/admin/overlays/add-feedback-link.yaml similarity index 100% rename from shared/overlays/sm-add-feedback-link.yaml rename to admin/overlays/add-feedback-link.yaml diff --git a/http-proxy/overlays/add-external-docs.yaml b/http-proxy/overlays/add-external-docs.yaml index 225e29f..915ff06 100644 --- a/http-proxy/overlays/add-external-docs.yaml +++ b/http-proxy/overlays/add-external-docs.yaml @@ -8,6 +8,9 @@ actions: # Add enhanced description to the info node - target: "$.info" update: + x-feedbackLink: + label: "Documentation update request" + url: "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" 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. diff --git a/schema-registry/overlays/add-external-docs.yaml b/schema-registry/overlays/add-external-docs.yaml index 145f41e..0837684 100644 --- a/schema-registry/overlays/add-external-docs.yaml +++ b/schema-registry/overlays/add-external-docs.yaml @@ -8,6 +8,9 @@ actions: # Add enhanced description to the info node - target: "$.info" update: + x-feedbackLink: + label: "Documentation update request" + url: "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" description: | Manage schemas within a Redpanda cluster. From de8990dd52a93a514b3eba598480d5d0f99b1b20 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 Aug 2025 11:41:53 +0100 Subject: [PATCH 09/17] Test diff --- admin/admin.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/admin/admin.yaml b/admin/admin.yaml index 1e11e8d..5ad8ad3 100644 --- a/admin/admin.yaml +++ b/admin/admin.yaml @@ -3,7 +3,7 @@ info: title: Redpanda Admin API version: 1.0.0 description: | - Use the Admin API to administer and manage Redpanda. + test diff Use the Admin API to administer and manage Redpanda. --- From 9e0df923e6ff74c21780d7cb72ea12fbe38b7afe Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 Aug 2025 11:44:18 +0100 Subject: [PATCH 10/17] Test diff --- http-proxy/overlays/add-external-docs.yaml | 3 --- http-proxy/overlays/add-feedback-link.yaml | 15 +++++++++++++++ schema-registry/overlays/add-external-docs.yaml | 3 --- schema-registry/overlays/add-feedback-link.yaml | 15 +++++++++++++++ 4 files changed, 30 insertions(+), 6 deletions(-) create mode 100644 http-proxy/overlays/add-feedback-link.yaml create mode 100644 schema-registry/overlays/add-feedback-link.yaml diff --git a/http-proxy/overlays/add-external-docs.yaml b/http-proxy/overlays/add-external-docs.yaml index 915ff06..225e29f 100644 --- a/http-proxy/overlays/add-external-docs.yaml +++ b/http-proxy/overlays/add-external-docs.yaml @@ -8,9 +8,6 @@ actions: # Add enhanced description to the info node - target: "$.info" update: - x-feedbackLink: - label: "Documentation update request" - url: "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" 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. diff --git a/http-proxy/overlays/add-feedback-link.yaml b/http-proxy/overlays/add-feedback-link.yaml new file mode 100644 index 0000000..4adde44 --- /dev/null +++ b/http-proxy/overlays/add-feedback-link.yaml @@ -0,0 +1,15 @@ +# Overlay to add feedback link to the API specification +# This adds a feedback button in the HTTP Proxy, Schema Registry, and Admin API docs +# for users to report issues through GitHub + +overlay: 1.0.0 +info: + title: Add Feedback Link + version: 1.0.0 +actions: + # Add x-feedbackLink to the top-level info element + - target: "$.info" + update: + x-feedbackLink: + label: "Documentation update request" + url: "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" diff --git a/schema-registry/overlays/add-external-docs.yaml b/schema-registry/overlays/add-external-docs.yaml index 0837684..145f41e 100644 --- a/schema-registry/overlays/add-external-docs.yaml +++ b/schema-registry/overlays/add-external-docs.yaml @@ -8,9 +8,6 @@ actions: # Add enhanced description to the info node - target: "$.info" update: - x-feedbackLink: - label: "Documentation update request" - url: "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" description: | Manage schemas within a Redpanda cluster. diff --git a/schema-registry/overlays/add-feedback-link.yaml b/schema-registry/overlays/add-feedback-link.yaml new file mode 100644 index 0000000..4adde44 --- /dev/null +++ b/schema-registry/overlays/add-feedback-link.yaml @@ -0,0 +1,15 @@ +# Overlay to add feedback link to the API specification +# This adds a feedback button in the HTTP Proxy, Schema Registry, and Admin API docs +# for users to report issues through GitHub + +overlay: 1.0.0 +info: + title: Add Feedback Link + version: 1.0.0 +actions: + # Add x-feedbackLink to the top-level info element + - target: "$.info" + update: + x-feedbackLink: + label: "Documentation update request" + url: "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" From 87529e8a7b16a874f8ef87abbcc4b8560f274f81 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 Aug 2025 13:14:28 +0100 Subject: [PATCH 11/17] Add feedbacklink --- http-proxy/http-proxy.json | 6 +++++- http-proxy/overlays/add-feedback-link.yaml | 15 --------------- schema-registry/overlays/add-feedback-link.yaml | 15 --------------- schema-registry/schema-registry.json | 6 +++++- .../overlays/sm-add-feedback-link.yaml | 0 5 files changed, 10 insertions(+), 32 deletions(-) delete mode 100644 http-proxy/overlays/add-feedback-link.yaml delete mode 100644 schema-registry/overlays/add-feedback-link.yaml rename admin/overlays/add-feedback-link.yaml => shared/overlays/sm-add-feedback-link.yaml (100%) diff --git a/http-proxy/http-proxy.json b/http-proxy/http-proxy.json index d9ce539..46667e7 100644 --- a/http-proxy/http-proxy.json +++ b/http-proxy/http-proxy.json @@ -2,7 +2,11 @@ "swagger": "2.0", "info": { "title": "Redpanda HTTP Proxy API", - "version": "0.0.2" + "version": "0.0.2", + "x-feedbackLink": { + "label": "Documentation update request", + "url": "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" + } }, "host": "{{Host}}", "basePath": "/", diff --git a/http-proxy/overlays/add-feedback-link.yaml b/http-proxy/overlays/add-feedback-link.yaml deleted file mode 100644 index 4adde44..0000000 --- a/http-proxy/overlays/add-feedback-link.yaml +++ /dev/null @@ -1,15 +0,0 @@ -# Overlay to add feedback link to the API specification -# This adds a feedback button in the HTTP Proxy, Schema Registry, and Admin API docs -# for users to report issues through GitHub - -overlay: 1.0.0 -info: - title: Add Feedback Link - version: 1.0.0 -actions: - # Add x-feedbackLink to the top-level info element - - target: "$.info" - update: - x-feedbackLink: - label: "Documentation update request" - url: "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" diff --git a/schema-registry/overlays/add-feedback-link.yaml b/schema-registry/overlays/add-feedback-link.yaml deleted file mode 100644 index 4adde44..0000000 --- a/schema-registry/overlays/add-feedback-link.yaml +++ /dev/null @@ -1,15 +0,0 @@ -# Overlay to add feedback link to the API specification -# This adds a feedback button in the HTTP Proxy, Schema Registry, and Admin API docs -# for users to report issues through GitHub - -overlay: 1.0.0 -info: - title: Add Feedback Link - version: 1.0.0 -actions: - # Add x-feedbackLink to the top-level info element - - target: "$.info" - update: - x-feedbackLink: - label: "Documentation update request" - url: "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" diff --git a/schema-registry/schema-registry.json b/schema-registry/schema-registry.json index 5ba7390..7410403 100644 --- a/schema-registry/schema-registry.json +++ b/schema-registry/schema-registry.json @@ -2,7 +2,11 @@ "swagger": "2.0", "info": { "title": "Redpanda Schema Registry API", - "version": "1.0.6" + "version": "1.0.6", + "x-feedbackLink": { + "label": "Documentation update request", + "url": "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" + } }, "host": "localhost:18081", "basePath": "/", diff --git a/admin/overlays/add-feedback-link.yaml b/shared/overlays/sm-add-feedback-link.yaml similarity index 100% rename from admin/overlays/add-feedback-link.yaml rename to shared/overlays/sm-add-feedback-link.yaml From b42d0bbe45d77950cfc8c20e3733e23202faff41 Mon Sep 17 00:00:00 2001 From: JakeSCahill Date: Mon, 18 Aug 2025 13:56:55 +0100 Subject: [PATCH 12/17] Replace swagger with openapi --- http-proxy/http-proxy.json | 8 ++------ schema-registry/schema-registry.json | 8 ++------ 2 files changed, 4 insertions(+), 12 deletions(-) diff --git a/http-proxy/http-proxy.json b/http-proxy/http-proxy.json index 46667e7..3689617 100644 --- a/http-proxy/http-proxy.json +++ b/http-proxy/http-proxy.json @@ -1,12 +1,8 @@ { - "swagger": "2.0", + "openapi": "2.0", "info": { "title": "Redpanda HTTP Proxy API", - "version": "0.0.2", - "x-feedbackLink": { - "label": "Documentation update request", - "url": "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" - } + "version": "0.0.2" }, "host": "{{Host}}", "basePath": "/", diff --git a/schema-registry/schema-registry.json b/schema-registry/schema-registry.json index 7410403..7fed545 100644 --- a/schema-registry/schema-registry.json +++ b/schema-registry/schema-registry.json @@ -1,12 +1,8 @@ { - "swagger": "2.0", + "openapi": "2.0", "info": { "title": "Redpanda Schema Registry API", - "version": "1.0.6", - "x-feedbackLink": { - "label": "Documentation update request", - "url": "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml" - } + "version": "1.0.6" }, "host": "localhost:18081", "basePath": "/", From a14afafea5cdf46587047b428ba8b4f3bc28ee1f Mon Sep 17 00:00:00 2001 From: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> Date: Tue, 19 Aug 2025 12:57:39 +0100 Subject: [PATCH 13/17] Update http-proxy.json --- http-proxy/http-proxy.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/http-proxy/http-proxy.json b/http-proxy/http-proxy.json index 3689617..4d427a3 100644 --- a/http-proxy/http-proxy.json +++ b/http-proxy/http-proxy.json @@ -1,5 +1,5 @@ { - "openapi": "2.0", + "swagger": "2.0", "info": { "title": "Redpanda HTTP Proxy API", "version": "0.0.2" @@ -11,7 +11,7 @@ ], "paths": {"/brokers": { "get": { - "summary": "test diff Get a list of brokers.", + "summary": "Get a list of brokers.", "operationId": "get_brokers", "produces": ["application/vnd.kafka.v2+json"], "responses": { @@ -570,4 +570,4 @@ } } } -} \ No newline at end of file +} From d58525a862b2218cff82f291ff8e58cc49093ad8 Mon Sep 17 00:00:00 2001 From: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> Date: Tue, 19 Aug 2025 12:57:54 +0100 Subject: [PATCH 14/17] Update schema-registry.json --- schema-registry/schema-registry.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/schema-registry/schema-registry.json b/schema-registry/schema-registry.json index 7fed545..b9c72b4 100644 --- a/schema-registry/schema-registry.json +++ b/schema-registry/schema-registry.json @@ -1,5 +1,5 @@ { - "openapi": "2.0", + "swagger": "2.0", "info": { "title": "Redpanda Schema Registry API", "version": "1.0.6" @@ -1334,4 +1334,4 @@ } } } -}} \ No newline at end of file +}} From 20104ae31b568b4190c68b6c8680c12f4cd080b0 Mon Sep 17 00:00:00 2001 From: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> Date: Tue, 19 Aug 2025 12:58:12 +0100 Subject: [PATCH 15/17] Update cloud-controlplane.yaml --- cloud-controlplane/cloud-controlplane.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/cloud-controlplane/cloud-controlplane.yaml b/cloud-controlplane/cloud-controlplane.yaml index 3442369..da8e725 100644 --- a/cloud-controlplane/cloud-controlplane.yaml +++ b/cloud-controlplane/cloud-controlplane.yaml @@ -1,7 +1,7 @@ components: schemas: AWS.Role: - description: test diff Role identifies AWS role. + description: Role identifies AWS role. properties: arn: description: AWS role ARN. From 732acfb771c961cf4106b21b5f2a963424811b0a Mon Sep 17 00:00:00 2001 From: Jake Cahill <45230295+JakeSCahill@users.noreply.github.com> Date: Tue, 19 Aug 2025 12:58:30 +0100 Subject: [PATCH 16/17] Update admin.yaml --- admin/admin.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/admin/admin.yaml b/admin/admin.yaml index 5ad8ad3..89e5fd0 100644 --- a/admin/admin.yaml +++ b/admin/admin.yaml @@ -3,7 +3,7 @@ info: title: Redpanda Admin API version: 1.0.0 description: | - test diff Use the Admin API to administer and manage Redpanda. + Use the Admin API to administer and manage Redpanda. --- @@ -6059,4 +6059,4 @@ tags: - name: Services description: Manage Redpanda services. - name: Unstable APIs - description: Developmental APIs that are subject to change. \ No newline at end of file + description: Developmental APIs that are subject to change. From e2e7eee8bb4bd72bcce77c2ff8e93cbd1e118909 Mon Sep 17 00:00:00 2001 From: kbatuigas <36839689+kbatuigas@users.noreply.github.com> Date: Tue, 19 Aug 2025 09:39:10 -0700 Subject: [PATCH 17/17] Update feedback link text --- shared/overlays/cloud-add-feedback-link.yaml | 2 +- shared/overlays/sm-add-feedback-link.yaml | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/shared/overlays/cloud-add-feedback-link.yaml b/shared/overlays/cloud-add-feedback-link.yaml index f863ff6..f2c509e 100644 --- a/shared/overlays/cloud-add-feedback-link.yaml +++ b/shared/overlays/cloud-add-feedback-link.yaml @@ -11,5 +11,5 @@ actions: - target: "$.info" update: x-feedbackLink: - label: "Documentation update request" + label: "Share feedback" url: "https://github.com/redpanda-data/cloud-docs/issues/new?template=01_doc_request.yml" diff --git a/shared/overlays/sm-add-feedback-link.yaml b/shared/overlays/sm-add-feedback-link.yaml index 4adde44..e9d63d1 100644 --- a/shared/overlays/sm-add-feedback-link.yaml +++ b/shared/overlays/sm-add-feedback-link.yaml @@ -11,5 +11,5 @@ actions: - target: "$.info" update: x-feedbackLink: - label: "Documentation update request" + label: "Share feedback" url: "https://github.com/redpanda-data/docs/issues/new?template=01_doc_request.yml"