redocly.yaml

Rama main · réplica de lectura del repositorio original.

# Filters the synced REST API spec (spec/openapi.yml) down to the endpoint
# tags each SDK exposes; everything else (admin, access-tokens, api-keys,
# untagged endpoints like /health) is dropped, and remove-unused-components
# then drops the component schemas only those operations referenced, so admin
# and cluster types never reach the generated clients. The SDK generate
# pipelines run `redocly bundle <api> -o spec/openapi_generated.<api>.yml`
# before invoking their client generators. The js-sdk list additionally keeps
# `auth` because the CLI reaches /teams through the js-sdk's generated schema.
#
# filter-out drops any node (operation or component schema) the upstream
# specs mark `x-not-implemented: true`. It has no applyTo on purpose: the
# flag must work on schemas as well as operations. A kept operation that
# still references a dropped schema loses that media-type entry rather
# than keeping a dangling $ref.
#
# The envd and volume apis filter the synced envd and volume-content specs
# (spec/envd/envd.yaml, spec/openapi-volumecontent.yml) the same way:
# operations the upstream specs mark `x-internal: true` belong to the
# orchestrator's control plane, not to SDKs, so they are dropped before the
# SDK schemas are generated. remove-unused-components then drops the
# component schemas only those operations referenced.
apis:
  js-sdk:
    root: spec/openapi.yml
    decorators:
      filter-in:
        property: tags
        value: [sandboxes, snapshots, templates, tags, auth, volumes, secrets]
        matchStrategy: any
        applyTo: Operation
      remove-unused-components: on
      filter-out:
        property: x-not-implemented
        value: [true]
  python-sdk:
    root: spec/openapi.yml
    decorators:
      filter-in:
        property: tags
        value: [sandboxes, snapshots, templates, tags, volumes, secrets]
        matchStrategy: any
        applyTo: Operation
      remove-unused-components: on
      filter-out:
        property: x-not-implemented
        value: [true]
  envd:
    root: spec/envd/envd.yaml
    decorators:
      filter-out:
        property: x-internal
        value: [true]
      remove-unused-components: on
  volume:
    root: spec/openapi-volumecontent.yml
    decorators:
      filter-out:
        property: x-internal
        value: [true]
      remove-unused-components: on