Typesense Analytics API — Analytics Rules

naftiko: 1.0.0-alpha2
info:
  label: Typesense Analytics API — Analytics Rules
  description: 'Typesense Analytics API — Analytics Rules. 5 operations. Lead operation: List All Analytics Rules. Self-contained
    Naftiko capability covering one Typesense business surface.'
  tags:
  - Typesense
  - Analytics Rules
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    TYPESENSE_API_KEY: TYPESENSE_API_KEY
capability:
  consumes:
  - type: http
    namespace: analytics-analytics-rules
    baseUri: ''
    description: Typesense Analytics API — Analytics Rules business capability. Self-contained, no shared references.
    resources:
    - name: analytics-rules
      path: /analytics/rules
      operations:
      - name: listanalyticsrules
        method: GET
        description: List All Analytics Rules
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createanalyticsrule
        method: POST
        description: Create An Analytics Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: analytics-rules-ruleName
      path: /analytics/rules/{ruleName}
      operations:
      - name: getanalyticsrule
        method: GET
        description: Retrieve An Analytics Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: upsertanalyticsrule
        method: PUT
        description: Create Or Update An Analytics Rule
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: deleteanalyticsrule
        method: DELETE
        description: Delete An Analytics Rule
        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: analytics-analytics-rules-rest
    port: 8080
    description: REST adapter for Typesense Analytics API — Analytics Rules. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/analytics/rules
      name: analytics-rules
      description: REST surface for analytics-rules.
      operations:
      - method: GET
        name: listanalyticsrules
        description: List All Analytics Rules
        call: analytics-analytics-rules.listanalyticsrules
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createanalyticsrule
        description: Create An Analytics Rule
        call: analytics-analytics-rules.createanalyticsrule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/analytics/rules/{rulename}
      name: analytics-rules-rulename
      description: REST surface for analytics-rules-ruleName.
      operations:
      - method: GET
        name: getanalyticsrule
        description: Retrieve An Analytics Rule
        call: analytics-analytics-rules.getanalyticsrule
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: upsertanalyticsrule
        description: Create Or Update An Analytics Rule
        call: analytics-analytics-rules.upsertanalyticsrule
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deleteanalyticsrule
        description: Delete An Analytics Rule
        call: analytics-analytics-rules.deleteanalyticsrule
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: analytics-analytics-rules-mcp
    port: 9090
    transport: http
    description: MCP adapter for Typesense Analytics API — Analytics Rules. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-all-analytics-rules
      description: List All Analytics Rules
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: analytics-analytics-rules.listanalyticsrules
      outputParameters:
      - type: object
        mapping: $.
    - name: create-analytics-rule
      description: Create An Analytics Rule
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: analytics-analytics-rules.createanalyticsrule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-analytics-rule
      description: Retrieve An Analytics Rule
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: analytics-analytics-rules.getanalyticsrule
      outputParameters:
      - type: object
        mapping: $.
    - name: create-update-analytics-rule
      description: Create Or Update An Analytics Rule
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: analytics-analytics-rules.upsertanalyticsrule
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-analytics-rule
      description: Delete An Analytics Rule
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: analytics-analytics-rules.deleteanalyticsrule
      outputParameters:
      - type: object
        mapping: $.