# Schema: HelpTextCollectionModel
---
allOf:
  - $ref: './collection_model.yml'
  - type: object
    required:
      - _links
      - _embedded
    properties:
      _links:
        type: object
        required:
          - self
        properties:
          self:
            allOf:
              - $ref: "./link.yml"
              - description: |-
                  This help text collection
                  
                  **Resource**: HelpTextCollectionModel
      _embedded:
        type: object
        required:
          - elements
        properties:
          elements:
            type: array
            items:
              $ref: './help_text_model.yml'

example:
  total: 2
  count: 2
  _type: Collection
  _embedded:
    elements:
      - _type: HelpText
        _links:
          self:
            href: "/api/v3/help_texts/1"
        id: 1
        attribute: id
        attributeCaption: ID
        scope: WorkPackage
        helpText:
          format: markdown
          raw: Help text for id attribute.
          html: "<p>Help text for id attribute.</p>"
      - _type: HelpText
        _links:
          self:
            href: "/api/v3/help_texts/2"
        id: 2
        attribute: status
        attributeCaption: Status
        scope: WorkPackage
        helpText:
          format: markdown
          raw: Help text for status attribute.
          html: "<p>Help text for status attribute.</p>"
  _links:
    self:
      href: "/api/v3/help_texts"
