[DOCS] Reformat type exists API docs (#47601)
This commit is contained in:
parent
63bb4c91eb
commit
f93bb9dac5
|
@ -5,8 +5,6 @@
|
|||
++++
|
||||
|
||||
Checks if an index exists.
|
||||
The returned HTTP status code indicates if the index exists or not.
|
||||
A `404` means it does not exist, and `200` means it does.
|
||||
|
||||
[source,console]
|
||||
--------------------------------------------------
|
||||
|
|
|
@ -1,16 +1,40 @@
|
|||
[[indices-types-exists]]
|
||||
=== Types Exists
|
||||
=== Type exists API
|
||||
++++
|
||||
<titleabbrev>Type exists</titleabbrev>
|
||||
++++
|
||||
|
||||
deprecated[7.0.0, Types are deprecated and are in the process of being removed. See <<removal-of-types>>.]
|
||||
deprecated::[7.0.0, Types are deprecated and are in the process of being removed. See <<removal-of-types>>.]
|
||||
|
||||
Used to check if a type/types exists in an index/indices.
|
||||
Checks if a <<mapping-type-field,mapping type>> exists.
|
||||
|
||||
[source,console]
|
||||
--------------------------------------------------
|
||||
----
|
||||
HEAD twitter/_mapping/tweet
|
||||
--------------------------------------------------
|
||||
----
|
||||
// TEST[setup:twitter]
|
||||
// TEST[warning:Type exists requests are deprecated, as types have been deprecated.]
|
||||
|
||||
The HTTP status code indicates if the type exists or not. A `404` means
|
||||
it does not exist, and `200` means it does.
|
||||
|
||||
[[indices-types-exists-api-request]]
|
||||
==== {api-request-title}
|
||||
|
||||
`HEAD /<index>/mapping/<type>`
|
||||
|
||||
|
||||
[[indices-types-exists-api-path-params]]
|
||||
==== {api-path-parms-title}
|
||||
|
||||
include::{docdir}/rest-api/common-parms.asciidoc[tag=index]
|
||||
|
||||
include::{docdir}/rest-api/common-parms.asciidoc[tag=type]
|
||||
|
||||
|
||||
[[indices-types-exists-api-response-codes]]
|
||||
==== {api-response-codes-title}
|
||||
|
||||
`200`::
|
||||
Indicates all specified mapping types exist.
|
||||
|
||||
`404`::
|
||||
Indicates one or more specified mapping types **do not** exist.
|
||||
|
|
|
@ -713,6 +713,13 @@ end::master-timeout[]
|
|||
|
||||
end::timeoutparms[]
|
||||
|
||||
tag::type[]
|
||||
`<type>`::
|
||||
(Optional, string)
|
||||
Comma-separated list or wildcard expression of types
|
||||
used to limit the request.
|
||||
end::type[]
|
||||
|
||||
tag::cat-v[]
|
||||
`v`::
|
||||
(Optional, boolean) If `true`, the response includes column headings.
|
||||
|
|
Loading…
Reference in New Issue