Typesense Search API — API Keys

naftiko: 1.0.0-alpha2
info:
  label: Typesense Search API — API Keys
  description: 'Typesense Search API — API Keys. 4 operations. Lead operation: Retrieve Metadata For All API Keys. Self-contained
    Naftiko capability covering one Typesense business surface.'
  tags:
  - Typesense
  - API Keys
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TYPESENSE_API_KEY: TYPESENSE_API_KEY
capability:
  consumes:
  - type: http
    namespace: search-api-keys
    baseUri: ''
    description: Typesense Search API — API Keys business capability. Self-contained, no shared references.
    resources:
    - name: keys
      path: /keys
      operations:
      - name: listapikeys
        method: GET
        description: Retrieve Metadata For All API Keys
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createapikey
        method: POST
        description: Create An API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: keys-keyId
      path: /keys/{keyId}
      operations:
      - name: getapikey
        method: GET
        description: Retrieve An API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: deleteapikey
        method: DELETE
        description: Delete An API Key
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    authentication:
      type: apikey
      key: X-TYPESENSE-API-KEY
      value: '{{env.TYPESENSE_API_KEY}}'
      placement: header
  exposes:
  - type: rest
    namespace: search-api-keys-rest
    port: 8080
    description: REST adapter for Typesense Search API — API Keys. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/keys
      name: keys
      description: REST surface for keys.
      operations:
      - method: GET
        name: listapikeys
        description: Retrieve Metadata For All API Keys
        call: search-api-keys.listapikeys
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createapikey
        description: Create An API Key
        call: search-api-keys.createapikey
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/keys/{keyid}
      name: keys-keyid
      description: REST surface for keys-keyId.
      operations:
      - method: GET
        name: getapikey
        description: Retrieve An API Key
        call: search-api-keys.getapikey
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteapikey
        description: Delete An API Key
        call: search-api-keys.deleteapikey
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-api-keys-mcp
    port: 9090
    transport: http
    description: MCP adapter for Typesense Search API — API Keys. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: retrieve-metadata-all-api-keys
      description: Retrieve Metadata For All API Keys
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-api-keys.listapikeys
      outputParameters:
      - type: object
        mapping: $.
    - name: create-api-key
      description: Create An API Key
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: search-api-keys.createapikey
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-api-key
      description: Retrieve An API Key
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-api-keys.getapikey
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-api-key
      description: Delete An API Key
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: search-api-keys.deleteapikey
      outputParameters:
      - type: object
        mapping: $.