Skip to content

Commit

Permalink
[DOCS][OAS] Add descriptions, tags, deprecation to connector APIs (el…
Browse files Browse the repository at this point in the history
…astic#184956)

(cherry picked from commit e6795e5)
  • Loading branch information
lcawl committed Jul 25, 2024
1 parent 156ccfe commit f9f1ff9
Show file tree
Hide file tree
Showing 41 changed files with 997 additions and 2,213 deletions.
907 changes: 205 additions & 702 deletions oas_docs/output/kibana.yaml

Large diffs are not rendered by default.

Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,12 @@
import { schema } from '@kbn/config-schema';

export const connectorTypesQuerySchema = schema.object({
feature_id: schema.maybe(schema.string()),
feature_id: schema.maybe(
schema.string({
meta: {
description:
'A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).',
},
})
),
});
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,7 @@
import { schema } from '@kbn/config-schema';

export const getConnectorParamsSchema = schema.object({
id: schema.string(),
id: schema.string({
meta: { description: 'An identifier for the connector.' },
}),
});
17 changes: 2 additions & 15 deletions x-pack/plugins/actions/docs/openapi/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,15 +13,7 @@ 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
command in the `x-pack/plugins/actions/docs/openapi/` folder:

```
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:
You can generate the `bundled` files by running the following commands:

```
npx @redocly/cli bundle entrypoint.yaml --output bundled.yaml --ext yaml
Expand All @@ -30,9 +22,4 @@ npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.y
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_serverless.json
```
Then join these files with the rest of the Kibana APIs per `oas_docs/README.md`
Loading

0 comments on commit f9f1ff9

Please sign in to comment.