FIWARE-NGSI v2 Specification — Registrations

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