Lucidworks Rules and Query Rewrites API — Rules

naftiko: 1.0.0-alpha2
info:
  label: Lucidworks Rules and Query Rewrites API — Rules
  description: 'Lucidworks Rules and Query Rewrites API — Rules. 5 operations. Lead operation: List rules. Self-contained
    Naftiko capability covering one Lucidworks business surface.'
  tags:
  - Lucidworks
  - Rules
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    LUCIDWORKS_API_KEY: LUCIDWORKS_API_KEY
capability:
  consumes:
  - type: http
    namespace: rules-rules
    baseUri: https://api.lucidworks.ai
    description: Lucidworks Rules and Query Rewrites API — Rules business capability. Self-contained, no shared references.
    resources:
    - name: rules
      path: /rules
      operations:
      - name: listrules
        method: GET
        description: List rules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createrule
        method: POST
        description: Create a rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: rules-ruleId
      path: /rules/{ruleId}
      operations:
      - name: getrule
        method: GET
        description: Get a rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ruleId
          in: path
          type: string
          required: true
      - name: updaterule
        method: PUT
        description: Update a rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ruleId
          in: path
          type: string
          required: true
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleterule
        method: DELETE
        description: Delete a rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: ruleId
          in: path
          type: string
          required: true
    authentication:
      type: bearer
      token: '{{env.LUCIDWORKS_API_KEY}}'
  exposes:
  - type: rest
    namespace: rules-rules-rest
    port: 8080
    description: REST adapter for Lucidworks Rules and Query Rewrites API — Rules. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/rules
      name: rules
      description: REST surface for rules.
      operations:
      - method: GET
        name: listrules
        description: List rules
        call: rules-rules.listrules
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createrule
        description: Create a rule
        call: rules-rules.createrule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/rules/{ruleid}
      name: rules-ruleid
      description: REST surface for rules-ruleId.
      operations:
      - method: GET
        name: getrule
        description: Get a rule
        call: rules-rules.getrule
        with:
          ruleId: rest.ruleId
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: updaterule
        description: Update a rule
        call: rules-rules.updaterule
        with:
          ruleId: rest.ruleId
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleterule
        description: Delete a rule
        call: rules-rules.deleterule
        with:
          ruleId: rest.ruleId
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: rules-rules-mcp
    port: 9090
    transport: http
    description: MCP adapter for Lucidworks Rules and Query Rewrites API — Rules. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: list-rules
      description: List rules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rules-rules.listrules
      outputParameters:
      - type: object
        mapping: $.
    - name: create-rule
      description: Create a rule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: rules-rules.createrule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: get-rule
      description: Get a rule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: rules-rules.getrule
      with:
        ruleId: tools.ruleId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-rule
      description: Update a rule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: rules-rules.updaterule
      with:
        ruleId: tools.ruleId
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-rule
      description: Delete a rule
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: rules-rules.deleterule
      with:
        ruleId: tools.ruleId
      outputParameters:
      - type: object
        mapping: $.