FIWARE-NGSI v2 Specification — Batch Operations

naftiko: 1.0.0-alpha2
info:
  label: FIWARE-NGSI v2 Specification — Batch Operations
  description: 'FIWARE-NGSI v2 Specification — Batch Operations. 3 operations. Lead operation: Notify. Self-contained Naftiko
    capability covering one Fiware business surface.'
  tags:
  - Fiware
  - Batch Operations
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FIWARE_API_KEY: FIWARE_API_KEY
capability:
  consumes:
  - type: http
    namespace: ngsiv2-batch-operations
    baseUri: http://orion.lab.fiware.org
    description: FIWARE-NGSI v2 Specification — Batch Operations business capability. Self-contained, no shared references.
    resources:
    - name: v2-op-notify
      path: /v2/op/notify
      operations:
      - name: notify
        method: POST
        description: Notify
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: string
          required: true
        - name: options
          in: query
          type: string
          description: Options dictionary
    - name: v2-op-query
      path: /v2/op/query
      operations:
      - name: query
        method: POST
        description: Query
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: string
          required: true
        - name: limit
          in: query
          type: number
          description: Limit the number of entities to be retrieved.
        - name: offset
          in: query
          type: number
          description: Skip a number of records.
        - name: orderBy
          in: query
          type: string
          description: Criteria for ordering results.
        - name: options
          in: query
          type: string
          description: Options dictionary
    - name: v2-op-update
      path: /v2/op/update
      operations:
      - name: update
        method: POST
        description: Update
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: Content-Type
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: string
          required: true
        - name: options
          in: query
          type: string
          description: Options dictionary
  exposes:
  - type: rest
    namespace: ngsiv2-batch-operations-rest
    port: 8080
    description: REST adapter for FIWARE-NGSI v2 Specification — Batch Operations. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v2/op/notify
      name: v2-op-notify
      description: REST surface for v2-op-notify.
      operations:
      - method: POST
        name: notify
        description: Notify
        call: ngsiv2-batch-operations.notify
        with:
          Content-Type: rest.Content-Type
          body: rest.body
          options: rest.options
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/op/query
      name: v2-op-query
      description: REST surface for v2-op-query.
      operations:
      - method: POST
        name: query
        description: Query
        call: ngsiv2-batch-operations.query
        with:
          Content-Type: rest.Content-Type
          body: rest.body
          limit: rest.limit
          offset: rest.offset
          orderBy: rest.orderBy
          options: rest.options
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/op/update
      name: v2-op-update
      description: REST surface for v2-op-update.
      operations:
      - method: POST
        name: update
        description: Update
        call: ngsiv2-batch-operations.update
        with:
          Content-Type: rest.Content-Type
          body: rest.body
          options: rest.options
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ngsiv2-batch-operations-mcp
    port: 9090
    transport: http
    description: MCP adapter for FIWARE-NGSI v2 Specification — Batch Operations. One tool per consumed operation, routed
      inline through this capability's consumes block.
    tools:
    - name: notify
      description: Notify
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ngsiv2-batch-operations.notify
      with:
        Content-Type: tools.Content-Type
        body: tools.body
        options: tools.options
      outputParameters:
      - type: object
        mapping: $.
    - name: query
      description: Query
      hints:
        readOnly: true
        destructive: false
        idempotent: false
      call: ngsiv2-batch-operations.query
      with:
        Content-Type: tools.Content-Type
        body: tools.body
        limit: tools.limit
        offset: tools.offset
        orderBy: tools.orderBy
        options: tools.options
      outputParameters:
      - type: object
        mapping: $.
    - name: update
      description: Update
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ngsiv2-batch-operations.update
      with:
        Content-Type: tools.Content-Type
        body: tools.body
        options: tools.options
      outputParameters:
      - type: object
        mapping: $.