Customize Style & Validation Rules
In Stoplight Next you can customize the style and validation settings. This provides a practical method for enforcing API design rules over multiple APIs. You can enable or disable rules that monitor and validate things like your API, operations, markdown, parameters, paths, and references. Enabling a rule means our spec validator will trigger either a warning (denoted by a yellow exclamation icon) or an error (denoted by a red exclamation icon) if the rules conditions are not met.
NOTE Stoplight Next uses an older version of Spectral (v2.0.6), which is several major versions behind the latest. In order to take advantage of the latest Spectral enhancements, consider using Stoplight Studio.
See here for more information on the differences between the products.
Style rules refer to non-OAS specific rules such as setting requirements around providing descriptions for operations. Style rules are denoted by a blue pencil icon and typically trigger warnings when enabled.
Validation rules refer to OAS specific rules that signify whether a
specification is technically correct. An example of a validation rule would be
requiring a unique
operationID for every operation. Validation rules are
denoted by a green check mark icon and typically trigger errors when enabled.
The Style & Validation rule engine is powered by our open-source project Spectral
- Select the Project you would like to modify
- Select the lint settings from the file explorer on the bottom left
The lint settings can also be accessed via the settings cog within the validation pane of the editor
- Enable or disable rules by clicking the toggle next to the rule you wish to modify
- Make sure to save your lint changes before exiting