dynco-nym
41fb17a31b
* WIP adding derive(ToSchema) * Derive ToSchema for more types * ContractBuildInformation on /nym_contracts_detailed * rustfmt * Add cfg_attr * A bunch of annotations * Compiles with utoipa 5.2 * WIP * Post rebase fixes * Gitattributes to ignore .sqlx diffs * generate Sqlx schema files * Improvements * Move ecash schema out of ecash crate * Move redocly config to nym-api/ * Move redocly config to nym-api/ * Remove ErrorResponse * Move generated openapi spec to .gitignore * Include BSL licence * Remove utoipa from ecash toml file * Remove placeholder annotations * Chain-watcher rebase changes * Update licence info * Treat Scalar as String in OpenAPI
28 lines
683 B
Markdown
28 lines
683 B
Markdown
# Test / validate OpenAPI spec
|
|
|
|
`redocly` CLI is an [OpenAPI linter][docs] that enforces good practices by
|
|
checking whether a series of lints are applied to your OpenAPI spec.
|
|
|
|
## Install
|
|
|
|
You need `npm` and `npx` ([official instructions][instructions])
|
|
|
|
## Run
|
|
|
|
```
|
|
./redocly.sh
|
|
```
|
|
|
|
## Configuration
|
|
|
|
- redocly.yaml is the main [config file](https://redocly.com/docs/redoc/config)
|
|
|
|
## Ignore file
|
|
|
|
- specifies lints to ignore (some lints may be false alarms/not applicable)
|
|
- if you want to add current CLI warnings to an ignore file, run redocly CLI
|
|
with `--generate-ignore-file`
|
|
|
|
[docs]: https://redocly.com/docs/redoc
|
|
[instructions]: https://redocly.com/docs/cli/installation
|