Skip to content
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

Add new code sample checks rule to main list #44

Merged
merged 2 commits into from
Oct 11, 2024
Merged

Add new code sample checks rule to main list #44

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ffd3de
Add new code sample checks rule to main list
lornajane Oct 11, 2024
014b31d
Update README.md
JLekawa Oct 11, 2024
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
1 change: 1 addition & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
> [!IMPORTANT]
> Redocly are the repository maintainers, but we can't thoroughly test everything here. Please browse, share, and use what you find at your own risk.

If you're new to Redocly CLI, start with the [documentation](https://redocly.com/docs/cli/) to get up and running, then come back here to pick out any elements you would like to re-use yourself. To keep up with new developments, either subscribe to the project repository, or [sign up for the Redocly product newsletter](https://redocly.com/product-updates/).

Check warning on line 8 in README.md

View workflow job for this annotation

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs/cli/. Request was redirected to https://redocly.com/docs/cli

Check warning on line 8 in README.md

View workflow job for this annotation

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/product-updates/. 200 - OK

## Usage

Expand All @@ -23,7 +23,7 @@

### Rulesets

Combine existing [built-in rules](https://redocly.com/docs/cli/rules/built-in-rules/) in ways that serve a specific purpose, and make a [resuable ruleset](https://redocly.com/docs/cli/guides/configure-rules/#create-a-reusable-ruleset).

Check warning on line 26 in README.md

View workflow job for this annotation

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs/cli/rules/built-in-rules/. 200 - OK

- [Spec-compliant ruleset](rulesets/spec-compliant/)
- [Spot common mistakes](rulesets/common-mistakes)
Expand All @@ -31,7 +31,7 @@

### Configurable rules

There are some fantastic examples of [configurable rules](https://redocly.com/docs/cli/rules/configurable-rules/) in the wild, we hope the list here inspires you to share more of your own!

Check warning on line 34 in README.md

View workflow job for this annotation

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs/cli/rules/configurable-rules/. 200 - OK

- [Ban certain words from descriptions](configurable-rules/description-banned-words/)
- [Require `items` field for schemas of type `array`](configurable-rules/required-items-for-array-schemas/)
Expand All @@ -49,7 +49,7 @@

### Custom plugins

The [custom plugin](https://redocly.com/docs/cli/custom-plugins/) is the ultimate in extensibility, but it's an advanced feature. Try these plugins for inspiration and to get you started. Rather than including the whole plugin, there are also sections for individual rules and decorators further down.

Check warning on line 52 in README.md

View workflow job for this annotation

GitHub Actions / linkcheck

link checker warning 

https://redocly.com/docs/cli/custom-plugins/. 200 - OK

#### Decorators (for custom plugins)

Expand All @@ -64,6 +64,7 @@
#### Rules (for custom plugins)

- [Validate Markdown](./custom-plugin-rules/markdown-validator) - check Markdown in description fields is valid.
- [Check code samples](./custom-plugin-rules/code-sample-checks) - check that an expected list of code samples is present in `x-code-samples` for every operation.

### Miscellaneous (including tips and tricks)

Expand Down
Loading