scalar-property-missing-example

Requires that every scalar property in the API description has either example or examples˙ defined. Scalar properties are any of the following types: string, number, null, boolean, integer.

API design principles

One of the main goals of your API description (and your API documentation) is to help consumers understand how your API behaves and what to expect when working with it.

Providing examples for properties in your API description not only improves the developer and user experience of working with your APIs, but also makes the documentation more complete. Many API documentation tools are able to automatically extract such example values from the API description, and let consumers use those values to test the APIs or send (mock) requests to the API directly from the documentation.

Configuration

To configure the rule, add it to the rules object in your configuration file. Set the desired severity for the rule.

rules:
  scalar-property-missing-example:
    severity: error

An example configuration:

rules:
  scalar-property-missing-example: error

Examples

Given this configuration:

rules:
  scalar-property-missing-example: error

Example of an incorrect schema:

schemas:
  User:
    type: object
    properties:
      email:
        description: User email address
        type: string
        format: email

Example of a correct schema:

schemas:
  User:
    type: object
    properties:
      email:
        description: User email address
        type: string
        format: email
        example: john.smith@example.com

Related rules

• no-invalid-media-type-examples
• no-invalid-parameter-examples
• no-invalid-schema-examples
• configurable rules

Resources

• Rule source
• Schema docs