[HTTP/OAS] Add descriptions for Logstash pipeline APIs (#184266)

elastic · May 29, 2024 · b34ff52 · b34ff52
1 parent 90d1dc5
commit b34ff52
Show file tree

Hide file tree

Showing 5 changed files with 18 additions and 0 deletions.
diff --git a/x-pack/plugins/logstash/server/routes/pipeline/delete.ts b/x-pack/plugins/logstash/server/routes/pipeline/delete.ts
@@ -14,6 +14,10 @@ export function registerPipelineDeleteRoute(router: LogstashPluginRouter) {
   router.delete(
     {
       path: '/api/logstash/pipeline/{id}',
+      options: {
+        access: 'public',
+        description: `Delete a managed Logstash pipeline`,
+      },
       validate: {
         params: schema.object({
           id: schema.string(),

diff --git a/x-pack/plugins/logstash/server/routes/pipeline/load.ts b/x-pack/plugins/logstash/server/routes/pipeline/load.ts
@@ -16,6 +16,10 @@ export function registerPipelineLoadRoute(router: LogstashPluginRouter) {
   router.get(
     {
       path: '/api/logstash/pipeline/{id}',
+      options: {
+        access: 'public',
+        description: `Get a managed Logstash pipeline`,
+      },
       validate: {
         params: schema.object({
           id: schema.string(),

diff --git a/x-pack/plugins/logstash/server/routes/pipeline/save.ts b/x-pack/plugins/logstash/server/routes/pipeline/save.ts
@@ -21,6 +21,10 @@ export function registerPipelineSaveRoute(
   router.put(
     {
       path: '/api/logstash/pipeline/{id}',
+      options: {
+        access: 'public',
+        description: `Create a managed Logstash pipeline`,
+      },
       validate: {
         params: schema.object({
           id: schema.string(),

diff --git a/x-pack/plugins/logstash/server/routes/pipelines/delete.ts b/x-pack/plugins/logstash/server/routes/pipelines/delete.ts
@@ -36,6 +36,9 @@ export function registerPipelinesDeleteRoute(router: LogstashPluginRouter) {
   router.post(
     {
       path: '/api/logstash/pipelines/delete',
+      options: {
+        description: `Delete managed Logstash pipelines`,
+      },
       validate: {
         body: schema.object({
           pipelineIds: schema.arrayOf(schema.string()),

diff --git a/x-pack/plugins/logstash/server/routes/pipelines/list.ts b/x-pack/plugins/logstash/server/routes/pipelines/list.ts
@@ -27,6 +27,9 @@ export function registerPipelinesListRoute(router: LogstashPluginRouter) {
   router.get(
     {
       path: '/api/logstash/pipelines',
+      options: {
+        description: `Get all managed Logstash pipelines`,
+      },
       validate: false,
     },
     wrapRouteWithLicenseCheck(