plugin-yaml-schema.yml

properties:
  name:
    type: string
    description: "Name of the plugin. For example: 'Shellcheck'"
  description:
    type: string
    description: "Description of what the plugin does. For example: 'Runs shellcheck on your shell scripts.'"
  author:
    type: string
    description: "Contact information for the author. For example: 'https://github.com/person'"
  requirements:
    type: array
    description: "Commands that are required to be present on the agent. For example: ['docker', 'docker-compose']"
  configuration:
    type: object
    description: "The JSON schema for the plugin’s configuration options. See http://json-schema.org and https://jsonschemalint.com/"
    properties:
      properties:
        type: object
        description: "A list of all plugin configuration properties."
      required:
        type: array
        description: "A list of the required plugin configuration properties."
      additionalProperties:
        type: boolean
        description: "Allow undefined properties. Recommended to be false, to help people catch typos."
    required:
      - properties
required:
  - name
  - description
  - author
  - requirements
  - configuration