mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-07-02 14:40:19 -07:00
Windows: Add "special" parameter types to docs (#42853)
* Windows: Add special parameter types Adding explicit parameter types now exposes this information in the module documentation, and proves really helpful. We only do this for non-string types as strings, mostly because strings are implicit. PS We also make copyright statements consistent and use #Requires for explicit library imports * Type "string" must be type "str" * A few more Copyright corrections * More fixes * Don't add file encoding to Powershell files * Don't add missing interfacetypes parameter Otherwise CI demands an incorrect version_added * Small fix
This commit is contained in:
parent
290df027e3
commit
95a1170908
127 changed files with 327 additions and 664 deletions
|
@ -55,6 +55,7 @@ options:
|
|||
dest:
|
||||
description:
|
||||
- Output the response body to a file.
|
||||
type: path
|
||||
version_added: '2.3'
|
||||
headers:
|
||||
description:
|
||||
|
@ -74,10 +75,12 @@ options:
|
|||
creates:
|
||||
description:
|
||||
- A filename, when it already exists, this step will be skipped.
|
||||
type: path
|
||||
version_added: '2.4'
|
||||
removes:
|
||||
description:
|
||||
- A filename, when it does not exist, this step will be skipped.
|
||||
type: path
|
||||
version_added: '2.4'
|
||||
return_content:
|
||||
description:
|
||||
|
@ -92,6 +95,7 @@ options:
|
|||
description:
|
||||
- A valid, numeric, HTTP status code that signifies success of the request.
|
||||
- Can also be comma separated list of status codes.
|
||||
type: list
|
||||
default: 200
|
||||
version_added: '2.4'
|
||||
timeout:
|
||||
|
@ -102,6 +106,7 @@ options:
|
|||
If your request contains a host name that requires resolution, and you set
|
||||
C(timeout) to a value greater than zero, but less than 15 seconds, it can
|
||||
take 15 seconds or more before your request times out.
|
||||
type: int
|
||||
default: 30
|
||||
version_added: '2.4'
|
||||
follow_redirects:
|
||||
|
@ -121,6 +126,7 @@ options:
|
|||
- If C(maximum_redirection) is set to 0 (zero)
|
||||
or C(follow_redirects) is set to C(none),
|
||||
or set to C(safe) when not doing C(GET) or C(HEAD) it prevents all redirection.
|
||||
type: int
|
||||
default: 5
|
||||
version_added: '2.4'
|
||||
validate_certs:
|
||||
|
@ -138,6 +144,7 @@ options:
|
|||
certificate file is not password protected.
|
||||
- Other authentication types can set I(client_cert_password) when the cert
|
||||
is password protected.
|
||||
type: path
|
||||
version_added: '2.4'
|
||||
client_cert_password:
|
||||
description:
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue