github-mirrors/logstash
1
0
Fork 0
mirror of https://github.com/elastic/logstash.git synced 2025-04-24 14:47:19 -04:00
Code Issues Projects Releases Packages Wiki Activity

Remove alpha annotations

Browse source 
Fixes #6372
This commit is contained in:
DeDe Morton 2016-12-07 13:43:16 -08:00
parent 3487feaba0
commit 9010c75914
2 changed files with 2 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/static/configuration.asciidoc vendored
View file

@ -89,7 +89,7 @@ types are supported.
[[array]]
==== Array
This type is now mostly deprecated in favor of using a standard type like `string` with the plugin defining the `:list => true` property for better type checking. It is still needed to handle lists of hashes or mixed types where type checking is not desired. added[5.0.0-alpha4,The :list property is available for better type checking]
This type is now mostly deprecated in favor of using a standard type like `string` with the plugin defining the `:list => true` property for better type checking. It is still needed to handle lists of hashes or mixed types where type checking is not desired.
Example:
@ -102,8 +102,6 @@ Example:
[float]
==== Lists
added[5.0.0-alpha4,The :list property is available for better type checking]
Not a type in and of itself, but a property types can have.
This makes it possible to type check multiple values.
Plugin authors can enable list checking by specifying `:list => true` when declaring an argument.
@ -222,8 +220,6 @@ Example:
[float]
==== URI
added[5.0.0-alpha4]
A URI can be anything from a full URL like 'http://elastic.co/' to a simple identifier
like 'foobar'. If the URI contains a password such as 'http://user:pass@example.net' the password
portion of the URI will not be logged or printed.

2
docs/static/include/pluginbody.asciidoc vendored
View file

@ -476,7 +476,7 @@ will become a valid boolean in the config. This coercion works for the
`:number` type as well where "1.2" becomes a float and "22" is an integer.
* `:default` - lets you specify a default value for a parameter
* `:required` - whether or not this parameter is mandatory (a Boolean `true` or `false`)
* `:list` - whether or not this value should be a list of values. Will typecheck the list members, and convert scalars to one element lists. Note that this mostly obviates the array type, though if you need lists of complex objects that will be more suitable. added[5.0.0-alpha4,The :list property is available for better type checking]
* `:list` - whether or not this value should be a list of values. Will typecheck the list members, and convert scalars to one element lists. Note that this mostly obviates the array type, though if you need lists of complex objects that will be more suitable.
* `:deprecated` - informational (also a Boolean `true` or `false`)
* `:obsolete` - used to declare that a given setting has been removed and is no longer functioning. The idea is to provide an informed upgrade path to users who are still using a now-removed setting.