Skip to content

Commit

Permalink
[7.3] [DOCS] Reformat delete pipeline API (#47172) (#47296)
Browse files Browse the repository at this point in the history
  • Loading branch information
jrodewig authored Sep 30, 2019
1 parent 628316a commit c925e4e
Showing 1 changed file with 76 additions and 53 deletions.
129 changes: 76 additions & 53 deletions docs/reference/ingest/apis/delete-pipeline.asciidoc
Original file line number Diff line number Diff line change
@@ -1,79 +1,102 @@
[[delete-pipeline-api]]
=== Delete Pipeline API
=== Delete pipeline API
++++
<titleabbrev>Delete pipeline</titleabbrev>
++++

The delete pipeline API deletes pipelines by ID or wildcard match (`my-*`, `*`).

//////////////////////////
Deletes one or more existing ingest pipeline.

////
[source,js]
--------------------------------------------------
PUT _ingest/pipeline/my-pipeline-id
----
PUT /_ingest/pipeline/my-pipeline-id
{
"description" : "describe pipeline",
"version" : 123,
"processors" : [
{
"set" : {
"field": "foo",
"value": "bar"
}
}
]
"description" : "example pipeline to delete",
"processors" : [ ]
}
--------------------------------------------------
// CONSOLE
//////////////////////////
PUT /_ingest/pipeline/pipeline-one
{
"description" : "another example pipeline to delete",
"processors" : [ ]
}
----
// CONSOLE
// TESTSETUP
////

[source,js]
--------------------------------------------------
DELETE _ingest/pipeline/my-pipeline-id
--------------------------------------------------
----
DELETE /_ingest/pipeline/my-pipeline-id
----
// CONSOLE
// TEST[continued]

//////////////////////////

[source,js]
--------------------------------------------------
{
"acknowledged": true
}
--------------------------------------------------
// TESTRESPONSE
[[delete-pipeline-api-request]]
==== {api-request-title}

[source,js]
--------------------------------------------------
PUT _ingest/pipeline/wild-one
{
"description" : "first pipeline to be wildcard deleted",
"processors" : [ ]
}
`DELETE /_ingest/pipeline/<pipeline>`

PUT _ingest/pipeline/wild-two
{
"description" : "second pipeline to be wildcard deleted",
"processors" : [ ]
}
--------------------------------------------------

[[delete-pipeline-api-path-params]]
==== {api-path-parms-title}

`<pipeline>`::
+
--
(Required, string) Pipeline ID or wildcard expression of pipeline IDs
used to limit the request.

To delete all ingest pipelines in a cluster,
use a value of `*`.
--


[[delete-pipeline-api-query-params]]
==== {api-query-parms-title}

include::{docdir}/rest-api/common-parms.asciidoc[tag=timeoutparms]


[[delete-pipeline-api-api-example]]
==== {api-examples-title}


[[delete-pipeline-api-specific-ex]]
===== Delete a specific ingest pipeline

[source,js]
----
DELETE /_ingest/pipeline/pipeline-one
----
// CONSOLE

//////////////////////////

[[delete-pipeline-api-wildcard-ex]]
===== Delete ingest pipelines using a wildcard expression

[source,js]
--------------------------------------------------
DELETE _ingest/pipeline/*
--------------------------------------------------
----
DELETE /_ingest/pipeline/pipeline-*
----
// CONSOLE

//////////////////////////

[[delete-pipeline-api-all-ex]]
===== Delete all ingest pipelines

[source,js]
--------------------------------------------------
----
DELETE /_ingest/pipeline/*
----
// CONSOLE

////
[source,js]
----
{
"acknowledged": true
}
--------------------------------------------------
----
// TESTRESPONSE
//////////////////////////
////

0 comments on commit c925e4e

Please sign in to comment.