Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
13 changes: 6 additions & 7 deletions x-pack/plugins/observability/docs/openapi/slo/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,22 +13,21 @@ A guide about the OpenApi specification can be found at [https://swagger.io/docs

## Tools

It is possible to validate the docs before bundling them with the following
It is possible to manually validate the docs before bundling them with the following
command in the `x-pack/plugins/observability/docs/openapi/slo` folder:

```bash
npx swagger-cli validate entrypoint.yaml
make validate
```

Then you can generate the `bundled` files by running the following commands:
Then you can generate the `bundled` files by running the following command- this target will automatically validate inputs and lint the result:

```bash
npx @redocly/cli bundle entrypoint.yaml --output bundled.yaml --ext yaml
npx @redocly/cli bundle entrypoint.yaml --output bundled.json --ext json
make bundle
```

After generating the json bundle ensure that it is also valid by running the following command:
To lint the generated bundle manually, run:

```bash
npx @redocly/cli lint bundled.json
make lint
```
Loading