chainLink and chainLinkItem schema composition.yaml

chainLink-and-chainLinkItem-schema-composition.yaml

components:
  schemas:
    chainLink:
      title: A Chain Link
      description: >-
        Representation of one chain link which can be used
        in multiple story chains.
      allOf:
        - $ref: '#/components/schemas/chainLinkItem'
        - type: object
          required:
            - chains_url
          properties:
            chains_url:
              description: >-
                A link to the API operation to return the paginated
                list of chains in which that this chain link is used.
              type: string
              format: uri
              maxLength: 256

    chainLinkItem:
      title: Chain Link Item
      description: >-
        An abbreviated Chain Link that appears in lists of chain links.
      type: object
      allOf:
        - $ref: '#/components/schemas/newChainLink'
        - type: object
          required:
            - id
            - type
            - authorId
            - createdAt
          properties:
            id:
              description: >-
                The unique ID of this chain link resource.
              type: string
              minLength: 4
              maxLength: 48
              pattern: ^[-_a-zA-Z0-9:+$]{4,48}$
              readOnly: true
            type:
              description:
                Describes what type of chain link this is.
              type: string
              enum:
                - plainText
                - richText
                - captionedImage
                - branch
            authorId:
              description: >-
                The ID of the author who created this chain link.
              type: string
              minLength: 4
              maxLength: 48
              pattern: ^[-_a-zA-Z0-9:+$]{4,48}$
              readOnly: true
            createdAt:
              description: >-
                When this instance was created, in
                [RFC 3339](https://www.rfc-editor.org/rfc/rfc3339)
                `date-time` format.
              type: string
              fromat: date-time
              readOnly: true