IBM WebSphere Notifications API

openapi: 3.1.0
info:
  title: Open Liberty APIs Applications Notifications API
  description: Open Liberty provides application programming interfaces that extend and complement Jakarta EE and MicroProfile APIs. Includes APIs for security, admin connectors, batch processing, messaging, health checking, metrics, OpenAPI documentation, and more. Open Liberty is the open-source foundation for WebSphere Liberty.
  version: 24.0.0
  license:
    name: Eclipse Public License 1.0
    url: https://www.eclipse.org/legal/epl-v10.html
  contact:
    name: Open Liberty Community
    url: https://openliberty.io/
servers:
- url: https://localhost:9443
  description: Default Open Liberty Server
security:
- basicAuth: []
tags:
- name: Notifications
  description: Alert and notification management
paths:
  /notifications:
    get:
      operationId: listNotifications
      summary: List Notifications
      description: Returns a list of notifications and alerts.
      tags:
      - Notifications
      parameters:
      - name: type
        in: query
        description: Filter by notification type
        schema:
          type: string
          enum:
          - vulnerability
          - health
          - compliance
          - fix
        example: vulnerability
      - name: read
        in: query
        description: Filter by read status
        schema:
          type: boolean
        example: true
      responses:
        '200':
          description: List of notifications
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Notification'
              examples:
                Listnotifications200Example:
                  summary: Default listNotifications 200 response
                  x-microcks-default: true
                  value:
                  - id: abc123
                    type: vulnerability
                    severity: info
                    title: Example Title
                    message: example_value
                    read: true
                    createdDate: '2026-01-15T10:30:00Z'
                    relatedResourceId: '500123'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    post:
      operationId: createNotificationSubscription
      summary: Create a Notification Subscription
      description: Subscribes to notifications from a specific MBean.
      tags:
      - Notifications
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
              - objectName
              properties:
                objectName:
                  type: string
                  description: ObjectName of the MBean to subscribe to
                filters:
                  type: array
                  items:
                    type: string
                  description: Notification type filters
            examples:
              CreatenotificationsubscriptionRequestExample:
                summary: Default createNotificationSubscription request
                x-microcks-default: true
                value:
                  objectName: example_value
                  filters:
                  - example_value
      responses:
        '201':
          description: Notification subscription created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/NotificationSubscription'
              examples:
                Createnotificationsubscription201Example:
                  summary: Default createNotificationSubscription 201 response
                  x-microcks-default: true
                  value:
                    id: abc123
                    objectName: example_value
                    filters:
                    - example_value
                    created: '2026-01-15T10:30:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /notifications/{notificationId}/read:
    post:
      operationId: markNotificationRead
      summary: Mark Notification as Read
      description: Marks a notification as read.
      tags:
      - Notifications
      parameters:
      - name: notificationId
        in: path
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: Notification marked as read
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /notifications/{subscriptionId}:
    get:
      operationId: getNotifications
      summary: Get Pending Notifications
      description: Returns pending notifications for a subscription.
      tags:
      - Notifications
      parameters:
      - name: subscriptionId
        in: path
        required: true
        description: Subscription identifier
        schema:
          type: string
        example: '500123'
      responses:
        '200':
          description: Pending notifications
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Notification_2'
              examples:
                Getnotifications200Example:
                  summary: Default getNotifications 200 response
                  x-microcks-default: true
                  value:
                  - type: example_value
                    source: example_value
                    message: example_value
                    sequenceNumber: 10
                    timestamp: 10
                    userData: example_value
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
    delete:
      operationId: deleteNotificationSubscription
      summary: Delete a Notification Subscription
      description: Unsubscribes from notifications.
      tags:
      - Notifications
      parameters:
      - name: subscriptionId
        in: path
        required: true
        schema:
          type: string
        example: '500123'
      responses:
        '204':
          description: Subscription deleted
        '401':
          $ref: '#/components/responses/Unauthorized'
        '404':
          $ref: '#/components/responses/NotFound'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  responses:
    BadRequest:
      description: Bad request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Authentication required
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Resource not found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    NotificationSubscription:
      type: object
      properties:
        id:
          type: string
          example: abc123
        objectName:
          type: string
          example: example_value
        filters:
          type: array
          items:
            type: string
          example: []
        created:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
    Notification_2:
      type: object
      properties:
        type:
          type: string
          example: example_value
        source:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
        sequenceNumber:
          type: integer
          example: 10
        timestamp:
          type: integer
          example: 10
        userData:
          type: object
          additionalProperties: true
          example: example_value
    Error:
      type: object
      properties:
        code:
          type: string
          example: example_value
        message:
          type: string
          example: example_value
      required:
      - code
      - message
    Notification:
      type: object
      properties:
        id:
          type: string
          example: abc123
        type:
          type: string
          enum:
          - vulnerability
          - health
          - compliance
          - fix
          example: vulnerability
        severity:
          type: string
          enum:
          - info
          - warning
          - critical
          example: info
        title:
          type: string
          example: Example Title
        message:
          type: string
          example: example_value
        read:
          type: boolean
          example: true
        createdDate:
          type: string
          format: date-time
          example: '2026-01-15T10:30:00Z'
        relatedResourceId:
          type: string
          example: '500123'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: MicroProfile JWT authentication
externalDocs:
  description: Open Liberty API Reference
  url: https://openliberty.io/docs/latest/reference/api/open-liberty-apis.html