Required Fields

Required Fields is a Schema Constraint that checks if a field is required, and confirms that required fields are defined.

Usage Example

  fields:
    - name: name
      type: string
      description: |
        The name of the type.
      is_required: true
    - name: package
      type: string
      description: |
        The 'dot notation' package name for the type.  All type names must be unique within an assigned type.
        The package will also define the directory structure produced by gen-plugin.
      is_required: true
    - name: description
      type: string
      description: |
        A brief description of the type.
      is_required: true

In the above example, the fields name and package are required, and the field description is not required. If name or package are not defined, it will fail the Required Fields constraint.