openproject/docs/api/apiv3/components/schemas/notification_collection_model.yml

# Schema: NotificationCollectionModel
---
allOf:
  - $ref: './collection_model.yml'
  - type: object
    required:
      - _links
      - _embedded
    properties:
      _links:
        type: object
        required:
          - self
        properties:
          self:
            allOf:
              - $ref: "./link.yml"
              - description: |-
                  This notification collection
                  
                  **Resource**: NotificationCollectionModel                  
          jumpTo:
            allOf:
              - $ref: "./link.yml"
              - description: |-
                  The notification collection at another offset
                  
                  **Resource**: NotificationCollectionModel                  
          changeSize:
            allOf:
              - $ref: "./link.yml"
              - description: |-
                  The notification collection with another size
                  
                  **Resource**: NotificationCollectionModel                  
      _embedded:
        type: object
        required:
          - elements
        properties:
          elements:
            type: array
            items:
              $ref: './notification_model.yml'

example:
  _type: Collection
  count: 2
  total: 2
  offset: 1
  pageSize: 20
  _embedded:
    elements:
      - _hint: Notification resource shortened for brevity
        id: 1
        readIAN: false
        reason: mentioned
      - _hint: Notification resource shortened for brevity
        id: 2
        readIAN: false
        reason: mentioned
    _links:
      self:
        href: '/api/v3/notifications?offset=1&pageSize=20'
      jumpTo:
        href: '/api/v3/notifications?filters=%5B%5D&offset=%7Boffset%7D&pageSize=20'
        templated: true
      changeSize:
        href: '/api/v3/notifications?filters=%5B%5D&offset=1&pageSize=%7Bsize%7D'
        templated: true