Backstage TechDocs API — Metadata

naftiko: 1.0.0-alpha2
info:
  label: Backstage TechDocs API — Metadata
  description: 'Backstage TechDocs API — Metadata. 2 operations. Lead operation: Backstage Get entity metadata for TechDocs.
    Self-contained Naftiko capability covering one Backstage business surface.'
  tags:
  - Backstage
  - Metadata
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BACKSTAGE_API_KEY: BACKSTAGE_API_KEY
capability:
  consumes:
  - type: http
    namespace: techdocs-metadata
    baseUri: https://localhost:7007/api/techdocs
    description: Backstage TechDocs API — Metadata business capability. Self-contained, no shared references.
    resources:
    - name: metadata-entity-namespace-kind-name
      path: /metadata/entity/{namespace}/{kind}/{name}
      operations:
      - name: getentitymetadata
        method: GET
        description: Backstage Get entity metadata for TechDocs
        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: metadata-techdocs-namespace-kind-name
      path: /metadata/techdocs/{namespace}/{kind}/{name}
      operations:
      - name: gettechdocsmetadata
        method: GET
        description: Backstage Get TechDocs metadata for an entity
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: namespace
          in: path
          type: string
          description: The entity namespace.
          required: true
        - name: kind
          in: path
          type: string
          description: The entity kind (e.g., Component, API).
          required: true
        - name: name
          in: path
          type: string
          description: The entity name.
          required: true
    authentication:
      type: bearer
      token: '{{env.BACKSTAGE_API_KEY}}'
  exposes:
  - type: rest
    namespace: techdocs-metadata-rest
    port: 8080
    description: REST adapter for Backstage TechDocs API — Metadata. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/metadata/entity/{namespace}/{kind}/{name}
      name: metadata-entity-namespace-kind-name
      description: REST surface for metadata-entity-namespace-kind-name.
      operations:
      - method: GET
        name: getentitymetadata
        description: Backstage Get entity metadata for TechDocs
        call: techdocs-metadata.getentitymetadata
        with:
          namespace: rest.namespace
          kind: rest.kind
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/metadata/techdocs/{namespace}/{kind}/{name}
      name: metadata-techdocs-namespace-kind-name
      description: REST surface for metadata-techdocs-namespace-kind-name.
      operations:
      - method: GET
        name: gettechdocsmetadata
        description: Backstage Get TechDocs metadata for an entity
        call: techdocs-metadata.gettechdocsmetadata
        with:
          namespace: rest.namespace
          kind: rest.kind
          name: rest.name
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: techdocs-metadata-mcp
    port: 9090
    transport: http
    description: MCP adapter for Backstage TechDocs API — Metadata. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: backstage-get-entity-metadata-techdocs
      description: Backstage Get entity metadata for TechDocs
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: techdocs-metadata.getentitymetadata
      with:
        namespace: tools.namespace
        kind: tools.kind
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.
    - name: backstage-get-techdocs-metadata-entity
      description: Backstage Get TechDocs metadata for an entity
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: techdocs-metadata.gettechdocsmetadata
      with:
        namespace: tools.namespace
        kind: tools.kind
        name: tools.name
      outputParameters:
      - type: object
        mapping: $.