Hoverfly Admin API — Simulation

naftiko: 1.0.0-alpha2
info:
  label: Hoverfly Admin API — Simulation
  description: 'Hoverfly Admin API — Simulation. 5 operations. Lead operation: Get simulation. Self-contained Naftiko capability
    covering one Hoverfly business surface.'
  tags:
  - Hoverfly
  - Simulation
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    HOVERFLY_API_KEY: HOVERFLY_API_KEY
capability:
  consumes:
  - type: http
    namespace: hoverfly-simulation
    baseUri: http://localhost:8888
    description: Hoverfly Admin API — Simulation business capability. Self-contained, no shared references.
    resources:
    - name: api-v2-simulation
      path: /api/v2/simulation
      operations:
      - name: getsimulation
        method: GET
        description: Get simulation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: replacesimulation
        method: PUT
        description: Replace simulation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: appendsimulation
        method: POST
        description: Append simulation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: clearsimulation
        method: DELETE
        description: Clear simulation
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: api-v2-simulation-schema
      path: /api/v2/simulation/schema
      operations:
      - name: getsimulationschema
        method: GET
        description: Get simulation JSON schema
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: hoverfly-simulation-rest
    port: 8080
    description: REST adapter for Hoverfly Admin API — Simulation. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/api/v2/simulation
      name: api-v2-simulation
      description: REST surface for api-v2-simulation.
      operations:
      - method: GET
        name: getsimulation
        description: Get simulation
        call: hoverfly-simulation.getsimulation
        outputParameters:
        - type: object
          mapping: $.
      - method: PUT
        name: replacesimulation
        description: Replace simulation
        call: hoverfly-simulation.replacesimulation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: appendsimulation
        description: Append simulation
        call: hoverfly-simulation.appendsimulation
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: clearsimulation
        description: Clear simulation
        call: hoverfly-simulation.clearsimulation
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/api/v2/simulation/schema
      name: api-v2-simulation-schema
      description: REST surface for api-v2-simulation-schema.
      operations:
      - method: GET
        name: getsimulationschema
        description: Get simulation JSON schema
        call: hoverfly-simulation.getsimulationschema
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: hoverfly-simulation-mcp
    port: 9090
    transport: http
    description: MCP adapter for Hoverfly Admin API — Simulation. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: get-simulation
      description: Get simulation
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hoverfly-simulation.getsimulation
      outputParameters:
      - type: object
        mapping: $.
    - name: replace-simulation
      description: Replace simulation
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: hoverfly-simulation.replacesimulation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: append-simulation
      description: Append simulation
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: hoverfly-simulation.appendsimulation
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: clear-simulation
      description: Clear simulation
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: hoverfly-simulation.clearsimulation
      outputParameters:
      - type: object
        mapping: $.
    - name: get-simulation-json-schema
      description: Get simulation JSON schema
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: hoverfly-simulation.getsimulationschema
      outputParameters:
      - type: object
        mapping: $.