diff --git a/docs/ibm-cloud-rules.md b/docs/ibm-cloud-rules.md index 9280fc35..66e7b4a3 100644 --- a/docs/ibm-cloud-rules.md +++ b/docs/ibm-cloud-rules.md @@ -7333,7 +7333,7 @@ paths: Description: This rule validates each unique schema and ensures that any example(s) defined -is a valid instance of that schema. +is a valid instance of that schema. Note that this rule is an alternative to `oas3-valid-schema-example` and exists because that rule uses heuristics to find schemas that result in false positives. Also note that this rule is not an alternative to `oas3-valid-media-example` (it does not look for examples outside of a schema) which is not as susceptible to false positives.