mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-06-29 01:44:36 -04:00
1e587406d8
Adds `warnings` syntax to the yaml test that allows you to expect
a `Warning` header that looks like:
```
- do:
warnings:
- '[index] is deprecated'
- quotes are not required because yaml
- but this argument is always a list, never a single string
- no matter how many warnings you expect
get:
index: test
type: test
id: 1
```
These are accessible from the docs with:
```
// TEST[warning:some warning]
```
This should help to force you to update the docs if you deprecate
something. You *must* add the warnings marker to the docs or the build
will fail. While you are there you *should* update the docs to add
deprecation warnings visible in the rendered results.
|
||
|---|---|---|
| .. | ||
| analyzer.asciidoc | ||
| boost.asciidoc | ||
| coerce.asciidoc | ||
| copy-to.asciidoc | ||
| doc-values.asciidoc | ||
| dynamic.asciidoc | ||
| enabled.asciidoc | ||
| fielddata.asciidoc | ||
| format.asciidoc | ||
| geohash-precision.asciidoc | ||
| geohash-prefix.asciidoc | ||
| geohash.asciidoc | ||
| ignore-above.asciidoc | ||
| ignore-malformed.asciidoc | ||
| include-in-all.asciidoc | ||
| index-options.asciidoc | ||
| index.asciidoc | ||
| lat-lon.asciidoc | ||
| multi-fields.asciidoc | ||
| norms.asciidoc | ||
| null-value.asciidoc | ||
| position-increment-gap.asciidoc | ||
| properties.asciidoc | ||
| search-analyzer.asciidoc | ||
| similarity.asciidoc | ||
| store.asciidoc | ||
| term-vector.asciidoc | ||