Axon Server REST API — Snapshots

naftiko: 1.0.0-alpha2
info:
  label: Axon Server REST API — Snapshots
  description: 'Axon Server REST API — Snapshots. 2 operations. Lead operation: Axon Framework - Get Snapshots for an Aggregate.
    Self-contained Naftiko capability covering one Axon Framework business surface.'
  tags:
  - Axon Framework
  - Snapshots
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    AXON_FRAMEWORK_API_KEY: AXON_FRAMEWORK_API_KEY
capability:
  consumes:
  - type: http
    namespace: axon-server-snapshots
    baseUri: ''
    description: Axon Server REST API — Snapshots business capability. Self-contained, no shared references.
    resources:
    - name: snapshots-aggregateId
      path: /snapshots/{aggregateId}
      operations:
      - name: getsnapshots
        method: GET
        description: Axon Framework - Get Snapshots for an Aggregate
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: aggregateId
          in: path
          type: string
          required: true
        - name: context
          in: query
          type: string
      - name: appendsnapshot
        method: POST
        description: Axon Framework - Append a Snapshot
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: aggregateId
          in: path
          type: string
          required: true
        - name: context
          in: query
          type: string
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
  exposes:
  - type: rest
    namespace: axon-server-snapshots-rest
    port: 8080
    description: REST adapter for Axon Server REST API — Snapshots. One Spectral-compliant resource per consumed operation,
      prefixed with /v1.
    resources:
    - path: /v1/snapshots/{aggregateid}
      name: snapshots-aggregateid
      description: REST surface for snapshots-aggregateId.
      operations:
      - method: GET
        name: getsnapshots
        description: Axon Framework - Get Snapshots for an Aggregate
        call: axon-server-snapshots.getsnapshots
        with:
          aggregateId: rest.aggregateId
          context: rest.context
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: appendsnapshot
        description: Axon Framework - Append a Snapshot
        call: axon-server-snapshots.appendsnapshot
        with:
          aggregateId: rest.aggregateId
          context: rest.context
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: axon-server-snapshots-mcp
    port: 9090
    transport: http
    description: MCP adapter for Axon Server REST API — Snapshots. One tool per consumed operation, routed inline through
      this capability's consumes block.
    tools:
    - name: axon-framework-get-snapshots-aggregate
      description: Axon Framework - Get Snapshots for an Aggregate
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: axon-server-snapshots.getsnapshots
      with:
        aggregateId: tools.aggregateId
        context: tools.context
      outputParameters:
      - type: object
        mapping: $.
    - name: axon-framework-append-snapshot
      description: Axon Framework - Append a Snapshot
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: axon-server-snapshots.appendsnapshot
      with:
        aggregateId: tools.aggregateId
        context: tools.context
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.