Skip to content

Commit f9f1ff9

Browse files
committed
[DOCS][OAS] Add descriptions, tags, deprecation to connector APIs (elastic#184956)
(cherry picked from commit e6795e5)
1 parent 156ccfe commit f9f1ff9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+997
-2213
lines changed

oas_docs/output/kibana.yaml

Lines changed: 205 additions & 702 deletions
Large diffs are not rendered by default.

x-pack/plugins/actions/common/routes/connector/apis/connector_types/schemas/v1.ts

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,12 @@
88
import { schema } from '@kbn/config-schema';
99

1010
export const connectorTypesQuerySchema = schema.object({
11-
feature_id: schema.maybe(schema.string()),
11+
feature_id: schema.maybe(
12+
schema.string({
13+
meta: {
14+
description:
15+
'A filter to limit the retrieved connector types to those that support a specific feature (such as alerting or cases).',
16+
},
17+
})
18+
),
1219
});

x-pack/plugins/actions/common/routes/connector/apis/get/schemas/v1.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,5 +8,7 @@
88
import { schema } from '@kbn/config-schema';
99

1010
export const getConnectorParamsSchema = schema.object({
11-
id: schema.string(),
11+
id: schema.string({
12+
meta: { description: 'An identifier for the connector.' },
13+
}),
1214
});

x-pack/plugins/actions/docs/openapi/README.md

Lines changed: 2 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -13,15 +13,7 @@ A guide about the openApi specification can be found at [https://swagger.io/docs
1313

1414
## Tools
1515

16-
It is possible to validate the docs before bundling them with the following
17-
command in the `x-pack/plugins/actions/docs/openapi/` folder:
18-
19-
```
20-
npx swagger-cli validate entrypoint.yaml
21-
npx swagger-cli validate entrypoint_serverless.yaml
22-
```
23-
24-
Then you can generate the `bundled` files by running the following commands:
16+
You can generate the `bundled` files by running the following commands:
2517

2618
```
2719
npx @redocly/cli bundle entrypoint.yaml --output bundled.yaml --ext yaml
@@ -30,9 +22,4 @@ npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.y
3022
npx @redocly/cli bundle entrypoint_serverless.yaml --output bundled_serverless.json --ext json
3123
```
3224

33-
You can run additional linting with the following command:
34-
35-
```
36-
npx @redocly/cli lint bundled.json
37-
npx @redocly/cli lint bundled_serverless.json
38-
```
25+
Then join these files with the rest of the Kibana APIs per `oas_docs/README.md`

0 commit comments

Comments
 (0)