Backstage Search API — Search

naftiko: 1.0.0-alpha2
info:
  label: Backstage Search API — Search
  description: 'Backstage Search API — Search. 1 operations. Lead operation: Backstage Query the search index. Self-contained
    Naftiko capability covering one Backstage business surface.'
  tags:
  - Backstage
  - Search
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    BACKSTAGE_API_KEY: BACKSTAGE_API_KEY
capability:
  consumes:
  - type: http
    namespace: search-search
    baseUri: https://localhost:7007/api/search
    description: Backstage Search API — Search business capability. Self-contained, no shared references.
    resources:
    - name: query
      path: /query
      operations:
      - name: searchquery
        method: GET
        description: Backstage Query the search index
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: term
          in: query
          type: string
          description: The search term to query for.
        - name: types
          in: query
          type: array
          description: Comma-separated list of document types to filter results (e.g., software-catalog, techdocs).
        - name: filters
          in: query
          type: object
          description: Key-value filter pairs to narrow search results. Filters are specific to the document type.
        - name: pageCursor
          in: query
          type: string
          description: Cursor for pagination. Obtained from a previous search response.
    authentication:
      type: bearer
      token: '{{env.BACKSTAGE_API_KEY}}'
  exposes:
  - type: rest
    namespace: search-search-rest
    port: 8080
    description: REST adapter for Backstage Search API — Search. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/query
      name: query
      description: REST surface for query.
      operations:
      - method: GET
        name: searchquery
        description: Backstage Query the search index
        call: search-search.searchquery
        with:
          term: rest.term
          types: rest.types
          filters: rest.filters
          pageCursor: rest.pageCursor
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-search-mcp
    port: 9090
    transport: http
    description: MCP adapter for Backstage Search API — Search. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: backstage-query-search-index
      description: Backstage Query the search index
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-search.searchquery
      with:
        term: tools.term
        types: tools.types
        filters: tools.filters
        pageCursor: tools.pageCursor
      outputParameters:
      - type: object
        mapping: $.