Skip to content

docs(ibm-valid-schema-example): clarify purpose and scope of rule #755

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
hudlow merged 1 commit into from
Jul 16, 2025
Merged

docs(ibm-valid-schema-example): clarify purpose and scope of rule #755

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/ibm-cloud-rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7333,7 +7333,7 @@ paths:
<tr>
<td valign=top><b>Description:</b></td>
<td>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.
</td>
</tr>
<tr>
Expand Down