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.

Sign up for GitHub

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

[8.15] [DOCS][OAS] Add descriptions, tags, deprecation to connector APIs (#184956) #189237

Merged
merged 1 commit into from
Jul 26, 2024
Merged

[8.15] [DOCS][OAS] Add descriptions, tags, deprecation to connector APIs (#184956) #189237

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
907 changes: 205 additions & 702 deletions oas_docs/output/kibana.yaml
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 8 additions & 1 deletion x-pack/plugins/actions/common/routes/connector/apis/connector_types/schemas/v1.ts
View file
Open in desktop
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).',
},
})
),
});
4 changes: 3 additions & 1 deletion x-pack/plugins/actions/common/routes/connector/apis/get/schemas/v1.ts
View file
Open in desktop
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
View file
Open in desktop
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
Loading