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.

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

[OAS] Add serverless connector APIs #168661

Merged
merged 8 commits into from
Oct 17, 2023
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
24 changes: 14 additions & 10 deletions x-pack/plugins/actions/docs/openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,19 +16,23 @@ A guide about the openApi specification can be found at [https://swagger.io/docs
It is possible to validate the docs before bundling them with the following
command in the `x-pack/plugins/actions/docs/openapi/` folder:

```
npx swagger-cli validate entrypoint.yaml
```
```
npx swagger-cli validate entrypoint.yaml
npx swagger-cli validate entrypoint_serverless.yaml
```

Then you can generate the `bundled` files by running the following commands:

```
npx @redocly/cli bundle entrypoint.yaml --output bundled.yaml --ext yaml
npx @redocly/cli bundle entrypoint.yaml --output bundled.json --ext json
```
```
npx @redocly/cli bundle entrypoint.yaml --output bundled.yaml --ext yaml
npx @redocly/cli bundle entrypoint.yaml --output bundled.json --ext json
npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.yaml --ext yaml
npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.json --ext json
```

You can run additional linting with the following command:

```
npx @redocly/cli lint bundled.json
```
```
npx @redocly/cli lint bundled.json
npx @redocly/cli lint bundled_serverless.json
```
Loading
Loading