Backstage

opencollection: 1.0.0
info:
  name: Backstage TechDocs API
  version: 1.0.0
items:
- info:
    name: Metadata
    type: folder
  items:
  - info:
      name: Backstage Get TechDocs metadata for an entity
      type: http
    http:
      method: GET
      url: https://localhost:7007/api/techdocs/metadata/techdocs/:namespace/:kind/:name
      params:
      - name: namespace
        value: ''
        type: path
        description: The entity namespace.
      - name: kind
        value: ''
        type: path
        description: The entity kind (e.g., Component, API).
      - name: name
        value: ''
        type: path
        description: The entity name.
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Returns the TechDocs metadata for a specific catalog entity, including the site name, description, and build information.
  - info:
      name: Backstage Get entity metadata for TechDocs
      type: http
    http:
      method: GET
      url: https://localhost:7007/api/techdocs/metadata/entity/:namespace/:kind/:name
      params:
      - name: namespace
        value: ''
        type: path
      - name: kind
        value: ''
        type: path
      - name: name
        value: ''
        type: path
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Returns catalog entity metadata relevant to TechDocs rendering, including the entity name, description, and TechDocs
      annotations.
- info:
    name: Documentation
    type: folder
  items:
  - info:
      name: Backstage Get TechDocs index page
      type: http
    http:
      method: GET
      url: https://localhost:7007/api/techdocs/docs/:namespace/:kind/:name
      params:
      - name: namespace
        value: ''
        type: path
      - name: kind
        value: ''
        type: path
      - name: name
        value: ''
        type: path
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Returns the root index page of the rendered TechDocs documentation for the specified entity. May trigger a sync
      if the documentation is out of date.
  - info:
      name: Backstage Get a specific TechDocs page or asset
      type: http
    http:
      method: GET
      url: https://localhost:7007/api/techdocs/docs/:namespace/:kind/:name/:path
      params:
      - name: namespace
        value: ''
        type: path
      - name: kind
        value: ''
        type: path
      - name: name
        value: ''
        type: path
      - name: path
        value: ''
        type: path
        description: Path to the documentation page or asset.
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Returns a specific page or static asset from the rendered TechDocs for the specified entity. The path is relative
      to the documentation root.
- info:
    name: Sync
    type: folder
  items:
  - info:
      name: Backstage Trigger TechDocs sync
      type: http
    http:
      method: POST
      url: https://localhost:7007/api/techdocs/sync/:namespace/:kind/:name
      params:
      - name: namespace
        value: ''
        type: path
      - name: kind
        value: ''
        type: path
      - name: name
        value: ''
        type: path
      auth:
        type: bearer
        token: '{{bearerToken}}'
    docs: Triggers a synchronization of the TechDocs content for the specified entity from the configured external storage
      provider.
bundled: true