Typesense Search API — Synonym Sets

naftiko: 1.0.0-alpha2
info:
  label: Typesense Search API — Synonym Sets
  description: 'Typesense Search API — Synonym Sets. 8 operations. Lead operation: List All Synonym Sets. Self-contained Naftiko
    capability covering one Typesense business surface.'
  tags:
  - Typesense
  - Synonym Sets
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TYPESENSE_API_KEY: TYPESENSE_API_KEY
capability:
  consumes:
  - type: http
    namespace: search-synonym-sets
    baseUri: ''
    description: Typesense Search API — Synonym Sets business capability. Self-contained, no shared references.
    resources:
    - name: synonym_sets
      path: /synonym_sets
      operations:
      - name: listsynonymsets
        method: GET
        description: List All Synonym Sets
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: synonym_sets-synonymSetName
      path: /synonym_sets/{synonymSetName}
      operations:
      - name: getsynonymset
        method: GET
        description: Retrieve A Synonym Set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: upsertsynonymset
        method: PUT
        description: Create Or Update A Synonym Set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesynonymset
        method: DELETE
        description: Delete A Synonym Set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: synonym_sets-synonymSetName-items
      path: /synonym_sets/{synonymSetName}/items
      operations:
      - name: listsynonymsetitems
        method: GET
        description: List Items In A Synonym Set
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: synonym_sets-synonymSetName-items-itemId
      path: /synonym_sets/{synonymSetName}/items/{itemId}
      operations:
      - name: getsynonymsetitem
        method: GET
        description: Retrieve A Synonym Set Item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: upsertsynonymsetitem
        method: PUT
        description: Create Or Update A Synonym Set Item
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deletesynonymsetitem
        method: DELETE
        description: Delete A Synonym Set Item
        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-synonym-sets-rest
    port: 8080
    description: REST adapter for Typesense Search API — Synonym Sets. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/synonym-sets
      name: synonym-sets
      description: REST surface for synonym_sets.
      operations:
      - method: GET
        name: listsynonymsets
        description: List All Synonym Sets
        call: search-synonym-sets.listsynonymsets
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synonym-sets/{synonymsetname}
      name: synonym-sets-synonymsetname
      description: REST surface for synonym_sets-synonymSetName.
      operations:
      - method: GET
        name: getsynonymset
        description: Retrieve A Synonym Set
        call: search-synonym-sets.getsynonymset
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: upsertsynonymset
        description: Create Or Update A Synonym Set
        call: search-synonym-sets.upsertsynonymset
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesynonymset
        description: Delete A Synonym Set
        call: search-synonym-sets.deletesynonymset
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synonym-sets/{synonymsetname}/items
      name: synonym-sets-synonymsetname-items
      description: REST surface for synonym_sets-synonymSetName-items.
      operations:
      - method: GET
        name: listsynonymsetitems
        description: List Items In A Synonym Set
        call: search-synonym-sets.listsynonymsetitems
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/synonym-sets/{synonymsetname}/items/{itemid}
      name: synonym-sets-synonymsetname-items-itemid
      description: REST surface for synonym_sets-synonymSetName-items-itemId.
      operations:
      - method: GET
        name: getsynonymsetitem
        description: Retrieve A Synonym Set Item
        call: search-synonym-sets.getsynonymsetitem
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: upsertsynonymsetitem
        description: Create Or Update A Synonym Set Item
        call: search-synonym-sets.upsertsynonymsetitem
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesynonymsetitem
        description: Delete A Synonym Set Item
        call: search-synonym-sets.deletesynonymsetitem
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: search-synonym-sets-mcp
    port: 9090
    transport: http
    description: MCP adapter for Typesense Search API — Synonym Sets. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: list-all-synonym-sets
      description: List All Synonym Sets
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-synonym-sets.listsynonymsets
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-synonym-set
      description: Retrieve A Synonym Set
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-synonym-sets.getsynonymset
      outputParameters:
      - type: object
        mapping: $.
    - name: create-update-synonym-set
      description: Create Or Update A Synonym Set
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-synonym-sets.upsertsynonymset
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-synonym-set
      description: Delete A Synonym Set
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: search-synonym-sets.deletesynonymset
      outputParameters:
      - type: object
        mapping: $.
    - name: list-items-synonym-set
      description: List Items In A Synonym Set
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-synonym-sets.listsynonymsetitems
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-synonym-set-item
      description: Retrieve A Synonym Set Item
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: search-synonym-sets.getsynonymsetitem
      outputParameters:
      - type: object
        mapping: $.
    - name: create-update-synonym-set-item
      description: Create Or Update A Synonym Set Item
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: search-synonym-sets.upsertsynonymsetitem
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-synonym-set-item
      description: Delete A Synonym Set Item
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: search-synonym-sets.deletesynonymsetitem
      outputParameters:
      - type: object
        mapping: $.