Adding description for the create route

elastic · Sep 17, 2024 · f117cdf · f117cdf
1 parent 83ea6ed
commit f117cdf
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 2 deletions.
diff --git a/x-pack/plugins/actions/common/routes/connector/response/schemas/v1.ts b/x-pack/plugins/actions/common/routes/connector/response/schemas/v1.ts
@@ -26,7 +26,10 @@ export const connectorResponseSchema = schema.object({
  schema.boolean({ meta: { description: 'Indicates whether the connector is missing secrets.' } })
  ),
  is_preconfigured: schema.boolean({
- meta: { description: 'Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ' },
+ meta: {
+ description:
+ 'Indicates whether the connector is preconfigured. If true, the `config` and `is_missing_secrets` properties are omitted from the response. ',
+ },
  }),
  is_deprecated: schema.boolean({
  meta: { description: 'Indicates whether the connector is deprecated.' },

diff --git a/x-pack/plugins/actions/server/routes/create.ts b/x-pack/plugins/actions/server/routes/create.ts
@@ -69,7 +69,9 @@ export const createActionRoute = (
  request: {
  params: schema.maybe(
  schema.object({
- id: schema.maybe(schema.string()),
+ id: schema.maybe(
+ schema.string({ meta: { description: 'An identifier for the connector.' } })
+ ),
  })
  ),
  body: bodySchema,