ETSI ISG CIM / NGSI-LD API — Subscriptions

naftiko: 1.0.0-alpha2
info:
  label: ETSI ISG CIM / NGSI-LD API — Subscriptions
  description: 'ETSI ISG CIM / NGSI-LD API — Subscriptions. 5 operations. Lead operation: 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: ngsi-ld-subscriptions
    baseUri: ''
    description: ETSI ISG CIM / NGSI-LD API — Subscriptions business capability. Self-contained, no shared references.
    resources:
    - name: subscriptions
      path: /subscriptions/
      operations:
      - name: retrievesubscriptions
        method: GET
        description: Retrieves the subscriptions available in an NGSI-LD system
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: createsubscription
        method: POST
        description: Creates a new Subscription within an NGSI-LD system
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: subscriptions-subscriptionId
      path: /subscriptions/{subscriptionId}
      operations:
      - name: retrievesubscriptionbyid
        method: GET
        description: Retrieves a specific Subscription from an NGSI-LD system
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
      - name: updatesubscription
        method: PATCH
        description: Updates a specific Subscription within an NGSI-LD system
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
      - name: removesubscription
        method: DELETE
        description: Removes a specific Subscription from an NGSI-LD system
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
  exposes:
  - type: rest
    namespace: ngsi-ld-subscriptions-rest
    port: 8080
    description: REST adapter for ETSI ISG CIM / NGSI-LD API — Subscriptions. One Spectral-compliant resource per consumed
      operation, prefixed with /v1.
    resources:
    - path: /v1/subscriptions
      name: subscriptions
      description: REST surface for subscriptions.
      operations:
      - method: GET
        name: retrievesubscriptions
        description: Retrieves the subscriptions available in an NGSI-LD system
        call: ngsi-ld-subscriptions.retrievesubscriptions
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createsubscription
        description: Creates a new Subscription within an NGSI-LD system
        call: ngsi-ld-subscriptions.createsubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/subscriptions/{subscriptionid}
      name: subscriptions-subscriptionid
      description: REST surface for subscriptions-subscriptionId.
      operations:
      - method: GET
        name: retrievesubscriptionbyid
        description: Retrieves a specific Subscription from an NGSI-LD system
        call: ngsi-ld-subscriptions.retrievesubscriptionbyid
        outputParameters:
        - type: object
          mapping: $.
      - method: PATCH
        name: updatesubscription
        description: Updates a specific Subscription within an NGSI-LD system
        call: ngsi-ld-subscriptions.updatesubscription
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
      - method: DELETE
        name: removesubscription
        description: Removes a specific Subscription from an NGSI-LD system
        call: ngsi-ld-subscriptions.removesubscription
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: ngsi-ld-subscriptions-mcp
    port: 9090
    transport: http
    description: MCP adapter for ETSI ISG CIM / NGSI-LD API — Subscriptions. One tool per consumed operation, routed inline
      through this capability's consumes block.
    tools:
    - name: retrieves-subscriptions-available-ngsi-ld
      description: Retrieves the subscriptions available in an NGSI-LD system
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ngsi-ld-subscriptions.retrievesubscriptions
      outputParameters:
      - type: object
        mapping: $.
    - name: creates-new-subscription-within-ngsi
      description: Creates a new Subscription within an NGSI-LD system
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: ngsi-ld-subscriptions.createsubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: retrieves-specific-subscription-ngsi-ld
      description: Retrieves a specific Subscription from an NGSI-LD system
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: ngsi-ld-subscriptions.retrievesubscriptionbyid
      outputParameters:
      - type: object
        mapping: $.
    - name: updates-specific-subscription-within-ngsi
      description: Updates a specific Subscription within an NGSI-LD system
      hints:
        readOnly: false
        destructive: false
        idempotent: true
      call: ngsi-ld-subscriptions.updatesubscription
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: removes-specific-subscription-ngsi-ld
      description: Removes a specific Subscription from an NGSI-LD system
      hints:
        readOnly: false
        destructive: true
        idempotent: true
      call: ngsi-ld-subscriptions.removesubscription
      outputParameters:
      - type: object
        mapping: $.