Skip to content

auto-docs: Update Cloud API spec #11

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.

Sign up for GitHub

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

Jump to bottom
Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

auto-docs: Update Cloud API spec #11

wants to merge 1 commit into from

Conversation

vbotbuildovich
Copy link

@vbotbuildovich vbotbuildovich commented Jul 30, 2025 •
edited
Loading

This PR updates the OpenAPI spec file for the Cloud API.
Triggered by commit: 4d915cfeac9d0719d22cdc549ab4048f9d5643b0

@vbotbuildovich vbotbuildovich requested a review from a team as a code owner July 30, 2025 18:32
@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 30, 2025 •
edited
Loading

🚨 Breaking API change detected:

Added (1)

  • PATCH /v1/organizations/current

Modified (12)

  • DELETE /v1/clusters/{id}
    • Response modified: 202
      • Content type modified: application/json
        • Property modified: operation
          • Property modified: response
  • DELETE /v1/networks/{id}
    • Response modified: 202
      • Content type modified: application/json
        • Property modified: operation
          • Property modified: response
  • DELETE /v1/serverless/clusters/{id}
    • Response modified: 202
      • Content type modified: application/json
        • Property modified: operation
          • Property modified: response
  • GET /v1/clusters
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: clusters
          • [Breaking] Property removed: internet_gateways
            • Removing a resource is always breaking unless it was deprecated before [Breaking]
          • Property added: nat_gateways
  • GET /v1/clusters/{id}
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: cluster
          • [Breaking] Property removed: internet_gateways
            • Removing a resource is always breaking unless it was deprecated before [Breaking]
          • Property added: nat_gateways
  • GET /v1/operations
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: operations
          • Property modified: response
  • GET /v1/operations/{id}
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: operation
          • Property modified: response
  • GET /v1/organizations/available
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: organizations
          • Property added: mfa_enforced
  • GET /v1/organizations/current
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: organization
          • Property added: mfa_enforced
  • POST /v1/clusters
    • Response modified: 202
      • Content type modified: application/json
        • Property modified: operation
          • Property modified: response
  • POST /v1/networks
    • Response modified: 202
      • Content type modified: application/json
        • Property modified: operation
          • Property modified: response
  • POST /v1/serverless/clusters
    • Response modified: 202
      • Content type modified: application/json
        • Property modified: operation
          • Property modified: response

Preview documentation

Powered by Bump.sh

@github-actions GitHub Actions
Copy link

github-actions bot commented Jul 30, 2025 •
edited
Loading

🚨 Breaking API change detected:

Added (20)

  • DELETE /v1/redpanda-connect/mcp-servers/{id}
  • DELETE /v1/roles/{role_name}
  • GET /v1/quotas
  • GET /v1/redpanda-connect/mcp-servers
  • GET /v1/redpanda-connect/mcp-servers/{id}
  • GET /v1/redpanda-connect/mcp-servers:getConfigSchema
  • GET /v1/roles
  • GET /v1/roles/{role_name}
  • GET /v1/roles/{role_name}/members
  • POST /v1/quotas
  • POST /v1/quotas:batchDelete
  • POST /v1/quotas:batchSet
  • POST /v1/quotas:delete
  • POST /v1/redpanda-connect/mcp-servers
  • POST /v1/redpanda-connect/mcp-servers/{id}:start
  • POST /v1/redpanda-connect/mcp-servers/{id}:stop
  • POST /v1/redpanda-connect/pipelines:lint-config
  • POST /v1/roles
  • PUT /v1/redpanda-connect/mcp-servers/{id}
  • PUT /v1/roles/{role_name}

Modified (63)

  • DELETE /v1/acls
    • Response modified: 200
      • Content type modified: application/json
        • Property modified: matching_acls
          • Property modified: error
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • DELETE /v1/cloud-storage/mount-tasks/{id}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • DELETE /v1/kafka-connect/clusters/{cluster_name}/connectors/{name}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • DELETE /v1/kafka-connect/clusters/{cluster_name}/secrets/{id}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • DELETE /v1/redpanda-connect/pipelines/{id}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • DELETE /v1/secrets/{id}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • DELETE /v1/topics/{topic_name}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • DELETE /v1/transforms/{name}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • DELETE /v1/users/{name}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/acls
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/cloud-storage/mount-tasks
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/cloud-storage/mount-tasks/{id}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/cloud-storage/topics/mountable
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/kafka-connect/clusters
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/kafka-connect/clusters/{cluster_name}
    • Response modified: 200
      • Content type modified: application/json
        • [Breaking] Property removed: cluster
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Properties added: address, info, name, plugins
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/kafka-connect/clusters/{cluster_name}/connectors
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/kafka-connect/clusters/{cluster_name}/connectors/{name}
    • Response modified: 200
      • Content type modified: application/json
        • [Breaking] Property removed: connector
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Properties added: config, name, tasks, type
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/kafka-connect/clusters/{cluster_name}/connectors/{name}/config
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • [Breaking] Response removed: 200
      • Removing a resource is always breaking unless it was deprecated before [Breaking]
  • GET /v1/kafka-connect/clusters/{cluster_name}/connectors/{name}/status
    • Response modified: 200
      • Content type modified: application/json
        • [Breaking] Property removed: status
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Properties added: connector, errors, holistic_state, name, tasks, type
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/kafka-connect/clusters/{cluster_name}/connectors/{name}/topics
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/kafka-connect/clusters/{cluster_name}/secrets
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/kafka-connect/clusters/{cluster_name}/secrets/{id}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/redpanda-connect/config-schema
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/redpanda-connect/pipelines
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/redpanda-connect/pipelines-by-secrets
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/redpanda-connect/pipelines-for-secret
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/redpanda-connect/pipelines/{id}
    • Response modified: 200
      • Content type modified: application/json
        • [Breaking] Property removed: pipeline
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Properties added: config_yaml, description, display_name, id, resources, state, status, tags, url
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/secret-scopes
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/secrets
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/secrets/{id}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/topics
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/topics/{topic_name}/configurations
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/transforms
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/transforms/{name}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • GET /v1/users
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PATCH /v1/topics-partitions
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PATCH /v1/topics/{topic_name}/configurations
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PATCH /v1/topics/{topic_name}/partitions
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • POST /v1/acls
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • POST /v1/cloud-storage/mount-tasks/{id}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • POST /v1/cloud-storage/topics/mount
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • POST /v1/cloud-storage/topics/unmount
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • POST /v1/kafka-connect/clusters/{cluster_name}/connectors
    • Response modified: 201
      • Content type modified: application/json
        • [Breaking] Property removed: connector
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Properties added: config, name, tasks, type
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • POST /v1/kafka-connect/clusters/{cluster_name}/connectors/{name}/restart
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • POST /v1/kafka-connect/clusters/{cluster_name}/secrets
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • POST /v1/redpanda-connect/pipelines
    • Response modified: 201
      • Content type modified: application/json
        • [Breaking] Property removed: pipeline
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Properties added: config_yaml, description, display_name, id, resources, state, status, tags, url
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • POST /v1/secrets
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • POST /v1/topics
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • POST /v1/users
    • Response modified: 400
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/kafka-connect/clusters/{cluster_name}/connectors/{name}/config
    • Response modified: 200
      • Content type modified: application/json
        • [Breaking] Property removed: connector
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Properties added: config, name, tasks, type
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/kafka-connect/clusters/{cluster_name}/connectors/{name}/pause
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/kafka-connect/clusters/{cluster_name}/connectors/{name}/resume
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/kafka-connect/clusters/{cluster_name}/connectors/{name}/stop
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/kafka-connect/clusters/{cluster_name}/connectors/{name}/topics/reset
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/kafka-connect/clusters/{cluster_name}/secrets/{id}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/redpanda-connect/pipelines/{id}
    • Response modified: 200
      • Content type modified: application/json
        • [Breaking] Property removed: pipeline
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Properties added: config_yaml, description, display_name, id, resources, state, status, tags, url
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/redpanda-connect/pipelines/{id}/start
    • Response modified: 200
      • Content type modified: application/json
        • [Breaking] Property removed: pipeline
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Properties added: config_yaml, description, display_name, id, resources, state, status, tags, url
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/redpanda-connect/pipelines/{id}/stop
    • Response modified: 200
      • Content type modified: application/json
        • [Breaking] Property removed: pipeline
          • Removing a resource is always breaking unless it was deprecated before [Breaking]
        • Properties added: config_yaml, description, display_name, id, resources, state, status, tags, url
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/secrets/{id}
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/topics-partitions
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/topics/{topic_name}/configurations
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/topics/{topic_name}/partitions
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 404
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
  • PUT /v1/users/{user.name}
    • Response modified: 400
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 401
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: 500
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure
    • Response modified: default
      • Content type modified: application/json
        • Property modified: details
          • Alternatives modified: BadRequest, QuotaFailure

Preview documentation

Powered by Bump.sh

@vbotbuildovich vbotbuildovich force-pushed the update-branch-api branch 4 times, most recently from b4e45fd to 5523c74 Compare August 5, 2025 19:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@JakeSCahill JakeSCahill Awaiting requested review from JakeSCahill

@kbatuigas kbatuigas Awaiting requested review from kbatuigas

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
auto-docs
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@vbotbuildovich