honeymoose/OpenSearch
1
0
Fork 0
mirror of https://github.com/honeymoose/OpenSearch.git synced 2025-02-22 21:05:23 +00:00
Code Issues Packages Projects Releases Wiki Activity

[DOCS] Reformat delete pipeline API (#47172) (#47294)

Browse Source
This commit is contained in:
James Rodewig 2019-09-30 11:38:46 -04:00 committed by GitHub
parent 312e32a3d7
commit 024d1f2ab9
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 77 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

131
docs/reference/ingest/apis/delete-pipeline.asciidoc
View File

@ -1,73 +1,96 @@
[[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,console]
--------------------------------------------------
PUT _ingest/pipeline/my-pipeline-id
----
PUT /_ingest/pipeline/my-pipeline-id
{
"description" : "describe pipeline",
"version" : 123,
"processors" : [
{
"set" : {
"field": "foo",
"value": "bar"
}
}
]
}
--------------------------------------------------
//////////////////////////
[source,console]
--------------------------------------------------
DELETE _ingest/pipeline/my-pipeline-id
--------------------------------------------------
// TEST[continued]
//////////////////////////
[source,console-result]
--------------------------------------------------
{
"acknowledged": true
}
--------------------------------------------------
[source,console]
--------------------------------------------------
PUT _ingest/pipeline/wild-one
{
"description" : "first pipeline to be wildcard deleted",
"description" : "example pipeline to delete",
"processors" : [ ]
}
PUT _ingest/pipeline/wild-two
PUT /_ingest/pipeline/pipeline-one
{
"description" : "second pipeline to be wildcard deleted",
"description" : "another example pipeline to delete",
"processors" : [ ]
}
--------------------------------------------------
//////////////////////////
----
// TESTSETUP
////
[source,console]
--------------------------------------------------
DELETE _ingest/pipeline/*
--------------------------------------------------
----
DELETE /_ingest/pipeline/my-pipeline-id
----
//////////////////////////
[[delete-pipeline-api-request]]
==== {api-request-title}
`DELETE /_ingest/pipeline/<pipeline>`
[[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,console]
----
DELETE /_ingest/pipeline/pipeline-one
----
[[delete-pipeline-api-wildcard-ex]]
===== Delete ingest pipelines using a wildcard expression
[source,console]
----
DELETE /_ingest/pipeline/pipeline-*
----
[[delete-pipeline-api-all-ex]]
===== Delete all ingest pipelines
[source,console]
----
DELETE /_ingest/pipeline/*
----
////
[source,console-result]
--------------------------------------------------
----
{
"acknowledged": true
}
--------------------------------------------------
//////////////////////////
----
////