Required Examples

(2 reviews)

provide-examples-on-parameters

general > provide-examples-on-parameters


Guidance

Always include examples in parameters and headers.

Applies to Parameter

Constraint

Type: Rego Validation

Reviews

SM
Syed Zafar MullickDec 26, 2023, 1:04 PM
RAML 1.0 URI params
Ruleset incorrectly requires examples for URI parameters in raml 1.0
CC
Carl CoxSep 14, 2022, 2:24 PM
Servers Object for OAS 3
Ruleset incorrectly requires examples when writing OAS 3 YAML Server object with variables. ```yaml servers: - url: https://{env}.example.com{port}/{basePath} description: Incorrectly flagged for ruleset variables: env: enum: - 'test' - 'dev' - 'prod' default: 'dev' port: enum: - '8443' - '443' default: '8443' basePath: default: v1 ```
TypeRuleset
OrganizationMuleSoft
Published by
MuleSoft Organization
Published onJan 10, 2023
Asset overview

Asset versions for 1.0.x

Asset versions
VersionActions
1.0.2
1.0.1
1.0.0