Redocly CLI Cookbook

A community collection of rulesets, configuration, custom plugins and other additions for Redocly CLI. We know our users have some great tips, examples, and code to share, and this is the place to do just that. We would love to have your contributions here too!

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 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.

Usage

Use the content here as a starting point for your own work.

Take a look at what's available in each category, and pick any that you think apply to your situation.
Each section links to the documentation for that feature, incase you need an introduction or refresher.
Copy and paste the examples you want to use into your own setup, then edit them to fit your own needs.

If you come up with something new, please consider sharing it here by opening a pull request.

Contributing

Please share your best Redocly CLI usage with us! Each item should be shared in its own pull request, following the existing directory structure and including the README template copied into each folder. Full instructions are in the CONTRIBUTING file.

Requests

If there's something you think should be in the collection and it isn't, let us know! Open an issue, and describe the problem you'd like to see solved with Redocly CLI. We can't make promises, but we are pretty sure someone out there will know the answer.

rule/require-array-items: false positive

Adding a type to the bar property makes the error go away, but I'm not clear on how the where is matching that schema in the first place.

swagger.json:

{
	"swagger": "2.0",
	"definitions": {
		"Foo": {
			"type": "object",
			"properties": {
				"bar": {}
			}
		}
	}
}

redocly.yml

https://github.com/Redocly/redocly-cli-cookbook/tree/main/configurable-rules/required-items-for-array-schemas

apis:
  main:
    root: swagger.json

rules:
  rule/require-array-items:
    subject:
      type: Schema
    assertions:
      required:
        - items
    where:
      - subject:
          type: Schema
          property: type
        assertions:
          const: array
    message: The 'items' field is required for schemas of array type.

Error:

$ npx redocly lint swagger.json
validating swagger.json...
[1] swagger.json:7:5 at #/definitions/Foo/properties/bar

The 'items' field is required for schemas of array type.

5 | 			"type": "object",
6 | 			"properties": {
7 | 				"bar": {}
8 | 			}
9 | 		}

Error was generated by the rule/require-array-items rule.


swagger.json: validated in 6ms

❌ Validation failed with 1 error.
run `redocly lint --generate-ignore-file` to add all problems to the ignore file.

redocly / redocly-cli-cookbook Goto Github PK