Backstage TechDocs API — Documentation

naftiko: 1.0.0-alpha2
info:
  label: Backstage TechDocs API — Documentation
  description: 'Backstage TechDocs API — Documentation. 2 operations. Lead operation: Backstage Get TechDocs index page. Self-contained
    Naftiko capability covering one Backstage business surface.'
  tags:
  - Backstage
  - Documentation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BACKSTAGE_API_KEY: BACKSTAGE_API_KEY
capability:
  consumes:
  - type: http
    namespace: techdocs-documentation
    baseUri: https://localhost:7007/api/techdocs
    description: Backstage TechDocs API — Documentation business capability. Self-contained, no shared references.
    resources:
    - name: docs-namespace-kind-name
      path: /docs/{namespace}/{kind}/{name}
      operations:
      - name: gettechdocsindex
        method: GET
        description: Backstage Get TechDocs index page
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: namespace
          in: path
          type: string
          required: true
        - name: kind
          in: path
          type: string
          required: true
        - name: name
          in: path
          type: string
          required: true
    - name: docs-namespace-kind-name-path
      path: /docs/{namespace}/{kind}/{name}/{path}
      operations:
      - name: gettechdocspage
        method: GET
        description: Backstage Get a specific TechDocs page or asset
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: namespace
          in: path
          type: string
          required: true
        - name: kind
          in: path
          type: string
          required: true
        - name: name
          in: path
          type: string
          required: true
        - name: path
          in: path
          type: string
          description: Path to the documentation page or asset.
          required: true
    authentication:
      type: bearer
      token: '{{env.BACKSTAGE_API_KEY}}'
  exposes:
  - type: rest
    namespace: techdocs-documentation-rest
    port: 8080
    description: REST adapter for Backstage TechDocs API — Documentation. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/docs/{namespace}/{kind}/{name}
      name: docs-namespace-kind-name
      description: REST surface for docs-namespace-kind-name.
      operations:
      - method: GET
        name: gettechdocsindex
        description: Backstage Get TechDocs index page
        call: techdocs-documentation.gettechdocsindex
        with:
          namespace: rest.namespace
          kind: rest.kind
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/docs/{namespace}/{kind}/{name}/{path}
      name: docs-namespace-kind-name-path
      description: REST surface for docs-namespace-kind-name-path.
      operations:
      - method: GET
        name: gettechdocspage
        description: Backstage Get a specific TechDocs page or asset
        call: techdocs-documentation.gettechdocspage
        with:
          namespace: rest.namespace
          kind: rest.kind
          name: rest.name
          path: rest.path
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: techdocs-documentation-mcp
    port: 9090
    transport: http
    description: MCP adapter for Backstage TechDocs API — Documentation. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: backstage-get-techdocs-index-page
      description: Backstage Get TechDocs index page
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: techdocs-documentation.gettechdocsindex
      with:
        namespace: tools.namespace
        kind: tools.kind
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: backstage-get-specific-techdocs-page
      description: Backstage Get a specific TechDocs page or asset
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: techdocs-documentation.gettechdocspage
      with:
        namespace: tools.namespace
        kind: tools.kind
        name: tools.name
        path: tools.path
      outputParameters:
      - type: object
        mapping: $.