FIWARE-NGSI v2 Specification — Subscriptions

naftiko: 1.0.0-alpha2
info:
  label: FIWARE-NGSI v2 Specification — Subscriptions
  description: 'FIWARE-NGSI v2 Specification — Subscriptions. 5 operations. Lead operation: List Subscriptions. Self-contained
    Naftiko capability covering one Fiware business surface.'
  tags:
  - Fiware
  - Subscriptions
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    FIWARE_API_KEY: FIWARE_API_KEY
capability:
  consumes:
  - type: http
    namespace: ngsiv2-subscriptions
    baseUri: http://orion.lab.fiware.org
    description: FIWARE-NGSI v2 Specification — Subscriptions business capability. Self-contained, no shared references.
    resources:
    - name: v2-subscriptions
      path: /v2/subscriptions
      operations:
      - name: listsubscriptions
        method: GET
        description: List Subscriptions
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: limit
          in: query
          type: number
          description: Limit the number of subscriptions to be retrieved
        - name: offset
          in: query
          type: number
          description: Skip a number of subscriptions
        - name: options
          in: query
          type: string
          description: Options dictionary
      - name: createsubscription
        method: POST
        description: Create Subscription
        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: v2-subscriptions-subscriptionId
      path: /v2/subscriptions/{subscriptionId}
      operations:
      - name: retrievesubscription
        method: GET
        description: Retrieve Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriptionId
          in: path
          type: string
          description: subscription Id.
          required: true
      - name: deletesubscription
        method: DELETE
        description: Delete subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriptionId
          in: path
          type: string
          description: subscription Id.
          required: true
      - name: updatesubscription
        method: PATCH
        description: Update Subscription
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: subscriptionId
          in: path
          type: string
          description: subscription Id.
          required: true
        - name: Content-Type
          in: header
          type: string
          required: true
        - name: body
          in: body
          type: string
          required: true
  exposes:
  - type: rest
    namespace: ngsiv2-subscriptions-rest
    port: 8080
    description: REST adapter for FIWARE-NGSI v2 Specification — Subscriptions. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/v2/subscriptions
      name: v2-subscriptions
      description: REST surface for v2-subscriptions.
      operations:
      - method: GET
        name: listsubscriptions
        description: List Subscriptions
        call: ngsiv2-subscriptions.listsubscriptions
        with:
          limit: rest.limit
          offset: rest.offset
          options: rest.options
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsubscription
        description: Create Subscription
        call: ngsiv2-subscriptions.createsubscription
        with:
          Content-Type: rest.Content-Type
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/v2/subscriptions/{subscriptionid}
      name: v2-subscriptions-subscriptionid
      description: REST surface for v2-subscriptions-subscriptionId.
      operations:
      - method: GET
        name: retrievesubscription
        description: Retrieve Subscription
        call: ngsiv2-subscriptions.retrievesubscription
        with:
          subscriptionId: rest.subscriptionId
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: deletesubscription
        description: Delete subscription
        call: ngsiv2-subscriptions.deletesubscription
        with:
          subscriptionId: rest.subscriptionId
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesubscription
        description: Update Subscription
        call: ngsiv2-subscriptions.updatesubscription
        with:
          subscriptionId: rest.subscriptionId
          Content-Type: rest.Content-Type
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ngsiv2-subscriptions-mcp
    port: 9090
    transport: http
    description: MCP adapter for FIWARE-NGSI v2 Specification — Subscriptions. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: list-subscriptions
      description: List Subscriptions
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ngsiv2-subscriptions.listsubscriptions
      with:
        limit: tools.limit
        offset: tools.offset
        options: tools.options
      outputParameters:
      - type: object
        mapping: $.
    - name: create-subscription
      description: Create Subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ngsiv2-subscriptions.createsubscription
      with:
        Content-Type: tools.Content-Type
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieve-subscription
      description: Retrieve Subscription
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ngsiv2-subscriptions.retrievesubscription
      with:
        subscriptionId: tools.subscriptionId
      outputParameters:
      - type: object
        mapping: $.
    - name: delete-subscription
      description: Delete subscription
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ngsiv2-subscriptions.deletesubscription
      with:
        subscriptionId: tools.subscriptionId
      outputParameters:
      - type: object
        mapping: $.
    - name: update-subscription
      description: Update Subscription
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ngsiv2-subscriptions.updatesubscription
      with:
        subscriptionId: tools.subscriptionId
        Content-Type: tools.Content-Type
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.