-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[DOCS] Reformat type exists API docs (#47601)
- Loading branch information
Showing
3 changed files
with
38 additions
and
9 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -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. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters