test_story.schema.yaml

$schema: https://json-schema.org/draft/2019-09/schema

type: object
properties:
  $schema:
    type: string
  description:
    type: string
    pattern: ^\p{Lu}[\s\S]*\.$
  prologues:
    type: array
    items:
      $ref: '#/definitions/SupplementalChapter'
  epilogues:
    type: array
    items:
      $ref: '#/definitions/SupplementalChapter'
  chapters:
    type: array
    items:
      $ref: '#/definitions/Chapter'
  version:
    $ref: '#/definitions/Version'
  distributions:
    $ref: '#/definitions/Distributions'
  warnings:
    $ref: '#/definitions/Warnings'
required: [chapters,description]
additionalProperties: false

definitions:
  Chapter:
    unevaluatedProperties: false
    allOf:
      - $ref: '#/definitions/ChapterRequest'
      - properties:
          method:
            oneOf:
              - type: array
                items:
                  $ref: '#/definitions/HttpMethod'
              - $ref: '#/definitions/HttpMethod'
          synopsis:
            type: string
            description: A brief description of the chapter.
            pattern: ^\p{Lu}[\s\S]*\.$|^\p{Lu}[\s\S]*\. \[(GET|PUT|POST|DELETE|PATCH|HEAD|OPTIONS)\]$
          pending:
            type: string
            description: An explanation is provided to clarify why it has been skipped.
          response:
            $ref: '#/definitions/ExpectedResponse'
          warnings:
            $ref: '#/definitions/Warnings'
        required: [synopsis]

  ReadChapter:
    allOf:
      - $ref: '#/definitions/Chapter'
      - type: object
        properties:
          response:
            $ref: '#/definitions/ActualResponse'
        required: [response]
        additionalProperties: false

  SupplementalChapter:
    unevaluatedProperties: false
    allOf:
      - $ref: '#/definitions/ChapterRequest'
      - type: object
        properties:
          status:
            description: Array of success HTTP status codes. Default to [200, 201].
            type: array
            default: [200, 201]
            items:
              type: integer

  HttpMethod:
    type: string
    # eslint-disable-next-line yml/sort-sequence-values
    enum: [GET, PUT, POST, DELETE, PATCH, HEAD, OPTIONS]

  ChapterRequest:
    type: object
    properties:
      id:
        type: string
        description: A unique identifier for the chapter, useful for accessing outputs.
      path:
        type: string
      method:
        $ref: '#/definitions/HttpMethod'
      parameters:
        type: object
        additionalProperties:
          $ref: '#/definitions/Parameter'
      request:
        $ref: '#/definitions/Request'
      output:
        $ref: '#/definitions/Output'
      version:
        $ref: '#/definitions/Version'
      distributions:
        $ref: '#/definitions/Distributions'
      retry:
        $ref: '#/definitions/Retry'
      response:
        $ref: '#/definitions/ExpectedResponse'
    required: [method, path]

  Output:
    description: |
      Describes output for a chapter.
      The keys are the names for the variable in the chapter output.
      The values are paths to the values in the response.
      The values should be in the form:
      - `payload.<payload-path>` for the payload
      - `headers.<header-name>` for the headers.
    type: object
    additionalProperties:
      anyOf:
        - type: string
        - $ref: '#/definitions/DetailedOutput'

  DetailedOutput:
    properties:
      path:
        type: string
      default:
        type:
          - boolean
          - number
          - string
    required:
      - path
    
  Version:
    description: |
      The semver range to execute the story or chapter against.
    type: string

  Distributions:
    description: |
      The list of distributions that support this API.
    type: object
    properties:
      included:
        $ref: '#/definitions/DistributionsList'
      excluded:
        $ref: '#/definitions/DistributionsList'
        
  DistributionsList:
    description: |
      The list of distributions that support this API.
    type: array
    items:
      type: string

  Retry:
    description: |
      Number of times to retry on error.
    type: object
    properties:
      count: 
        type: integer
        description: Number of retries.
      wait:
        type: integer
        description: Number of milliseconds to wait before retrying.
    required:
      - count
    additionalProperties: false

  Request:
    type: object
    properties:
      content_type:
        type: string
        default: application/json
      headers:
        type: object
        additionalProperties:
          $ref: '#/definitions/Header'
      payload:
        $ref: '#/definitions/Payload'
    additionalProperties: false

  ExpectedResponse:
    type: object
    properties:
      status:
        type: integer
        description: The expected HTTP status code. Default to 200.
        default: 200
      content_type:
        type: string
        default: application/json
      payload:
        $ref: '#/definitions/Payload'
    required: [status]
    additionalProperties: false

  ActualResponse:
    type: object
    properties:
      status:
        type: integer
      content_type:
        type: string
      payload:
        $ref: '#/definitions/Payload'
      message:
        type: string
        description: Error message for non 2XX responses.
      error:
        type: object
        description: Error object.
    required: [content_type, payload, status]
    additionalProperties: false

  Header:
    anyOf:
      - type: string
      - type: number
      - type: boolean

  Payload:
    anyOf:
      - type: object
      - type: array
      - type: string
      - type: number
      - type: boolean

  Parameter:
    anyOf:
      - type: array
        items:
          oneOf:
            - type: string
            - type: number
            - type: boolean
      - type: string
      - type: number
      - type: boolean

  Warnings:
    type: object
    properties:
      multiple-paths-detected:
        type: boolean
        default: true
        description: Enable/disable warnings about multiple paths being tested in the same story.
      invalid-path-detected:
        type: boolean
        default: true
        description: Enable/disable warnings about file paths that do not match paths tested in the story.
    additionalProperties: false