[OAS] Add legacy connector API response descriptions

elastic · Aug 28, 2024 · 311504f · 311504f
1 parent c736c81
commit 311504f
Show file tree

Hide file tree

Showing 5 changed files with 42 additions and 7 deletions.
diff --git a/x-pack/plugins/actions/server/routes/legacy/create.ts b/x-pack/plugins/actions/server/routes/legacy/create.ts
@@ -40,7 +40,14 @@ export const createActionRoute = (
         deprecated: true,
       },
       validate: {
-        body: bodySchema,
+        request: {
+          body: bodySchema,
+        },
+        response: {
+          200: {
+            description: 'Indicates a successful call.',
+          },
+        },
       },
     },
     router.handleLegacyErrors(

diff --git a/x-pack/plugins/actions/server/routes/legacy/delete.ts b/x-pack/plugins/actions/server/routes/legacy/delete.ts
@@ -35,7 +35,14 @@ export const deleteActionRoute = (
         deprecated: true,
       },
       validate: {
-        params: paramSchema,
+        request: {
+          params: paramSchema,
+        },
+        response: {
+          204: {
+            description: 'Indicates a successful call.',
+          },
+        },
       },
     },
     router.handleLegacyErrors(async function (context, req, res) {

diff --git a/x-pack/plugins/actions/server/routes/legacy/execute.ts b/x-pack/plugins/actions/server/routes/legacy/execute.ts
@@ -40,8 +40,15 @@ export const executeActionRoute = (
         tags: ['oas-tag:connectors'],
       },
       validate: {
-        body: bodySchema,
-        params: paramSchema,
+        request: {
+          body: bodySchema,
+          params: paramSchema,
+        },
+        response: {
+          200: {
+            description: 'Indicates a successful call.',
+          },
+        },
       },
     },
     router.handleLegacyErrors(async function (context, req, res) {

diff --git a/x-pack/plugins/actions/server/routes/legacy/get.ts b/x-pack/plugins/actions/server/routes/legacy/get.ts
@@ -34,7 +34,14 @@ export const getActionRoute = (
         tags: ['oas-tag:connectors'],
       },
       validate: {
-        params: paramSchema,
+        request: {
+          params: paramSchema,
+        },
+        response: {
+          200: {
+            description: 'Indicates a successful call.',
+          },
+        },
       },
     },
     router.handleLegacyErrors(async function (context, req, res) {

diff --git a/x-pack/plugins/actions/server/routes/legacy/update.ts b/x-pack/plugins/actions/server/routes/legacy/update.ts
@@ -40,8 +40,15 @@ export const updateActionRoute = (
         tags: ['oas-tag:connectors'],
       },
       validate: {
-        body: bodySchema,
-        params: paramSchema,
+        request: {
+          body: bodySchema,
+          params: paramSchema,
+        },
+        response: {
+          200: {
+            description: 'Indicates a successful call.',
+          },
+        },
       },
     },
     router.handleLegacyErrors(async function (context, req, res) {