Shuffle API — Notifications

naftiko: 1.0.0-alpha2
info:
  label: Shuffle API — Notifications
  description: 'Shuffle API — Notifications. 4 operations. Lead operation: List Notifications. Self-contained Naftiko capability
    covering one Shuffle business surface.'
  tags:
  - Shuffle
  - Notifications
  created: '2026-05-19'
  modified: '2026-05-19'
binds:
- namespace: env
  keys:
    SHUFFLE_API_KEY: SHUFFLE_API_KEY
capability:
  consumes:
  - type: http
    namespace: shuffle-notifications
    baseUri: https://shuffler.io/api/v1
    description: Shuffle API — Notifications business capability. Self-contained, no shared references.
    resources:
    - name: notifications
      path: /notifications
      operations:
      - name: listnotifications
        method: GET
        description: List Notifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: status
          in: query
          type: string
          description: Filter by status
        - name: type
          in: query
          type: string
          description: Filter by notification type
        - name: severity
          in: query
          type: string
          description: Filter by severity level
      - name: createnotification
        method: POST
        description: Create Notification
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: body
          in: body
          type: object
          description: Request body (JSON).
          required: true
    - name: notifications-clear
      path: /notifications/clear
      operations:
      - name: clearnotifications
        method: GET
        description: Clear Notifications
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
    - name: notifications-id-markasread
      path: /notifications/{id}/markasread
      operations:
      - name: marknotificationasread
        method: GET
        description: Mark Notification As Read
        outputRawFormat: json
        outputParameters:
        - name: result
          type: object
          value: $.
        inputParameters:
        - name: id
          in: path
          type: string
          description: Notification ID
          required: true
    authentication:
      type: bearer
      token: '{{env.SHUFFLE_API_KEY}}'
  exposes:
  - type: rest
    namespace: shuffle-notifications-rest
    port: 8080
    description: REST adapter for Shuffle API — Notifications. One Spectral-compliant resource per consumed operation, prefixed
      with /v1.
    resources:
    - path: /v1/notifications
      name: notifications
      description: REST surface for notifications.
      operations:
      - method: GET
        name: listnotifications
        description: List Notifications
        call: shuffle-notifications.listnotifications
        with:
          status: rest.status
          type: rest.type
          severity: rest.severity
        outputParameters:
        - type: object
          mapping: $.
      - method: POST
        name: createnotification
        description: Create Notification
        call: shuffle-notifications.createnotification
        with:
          body: rest.body
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notifications/clear
      name: notifications-clear
      description: REST surface for notifications-clear.
      operations:
      - method: GET
        name: clearnotifications
        description: Clear Notifications
        call: shuffle-notifications.clearnotifications
        outputParameters:
        - type: object
          mapping: $.
    - path: /v1/notifications/{id}/markasread
      name: notifications-id-markasread
      description: REST surface for notifications-id-markasread.
      operations:
      - method: GET
        name: marknotificationasread
        description: Mark Notification As Read
        call: shuffle-notifications.marknotificationasread
        with:
          id: rest.id
        outputParameters:
        - type: object
          mapping: $.
  - type: mcp
    namespace: shuffle-notifications-mcp
    port: 9090
    transport: http
    description: MCP adapter for Shuffle API — Notifications. One tool per consumed operation, routed inline through this
      capability's consumes block.
    tools:
    - name: list-notifications
      description: List Notifications
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shuffle-notifications.listnotifications
      with:
        status: tools.status
        type: tools.type
        severity: tools.severity
      outputParameters:
      - type: object
        mapping: $.
    - name: create-notification
      description: Create Notification
      hints:
        readOnly: false
        destructive: false
        idempotent: false
      call: shuffle-notifications.createnotification
      with:
        body: tools.body
      outputParameters:
      - type: object
        mapping: $.
    - name: clear-notifications
      description: Clear Notifications
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shuffle-notifications.clearnotifications
      outputParameters:
      - type: object
        mapping: $.
    - name: mark-notification-read
      description: Mark Notification As Read
      hints:
        readOnly: true
        destructive: false
        idempotent: true
      call: shuffle-notifications.marknotificationasread
      with:
        id: tools.id
      outputParameters:
      - type: object
        mapping: $.