adding ansible types in documentation (#303)

Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician 2019-07-16 14:19:07 -07:00 committed by Alex Stephen
parent 72e4cc7214
commit 43536a1e38
81 changed files with 844 additions and 0 deletions

View file

@ -57,32 +57,38 @@ options:
name-of-resource` to a gcp_compute_backend_service task and then set this default_service
field to "{{ name-of-resource }}"'
required: true
type: dict
description:
description:
- An optional description of this resource. Provide this property when you create
the resource.
required: false
type: str
host_rules:
description:
- The list of HostRules to use against the URL.
required: false
type: list
suboptions:
description:
description:
- An optional description of this HostRule. Provide this property when you
create the resource.
required: false
type: str
hosts:
description:
- The list of host patterns to match. They must be valid hostnames, except
* will match any string of ([a-z0-9-.]*). In that case, * must be the first
character and must be followed in the pattern by either - or .
required: true
type: list
path_matcher:
description:
- The name of the PathMatcher to use to match the path portion of the URL
if the hostRule matches the URL's host portion.
required: true
type: str
name:
description:
- Name of the resource. Provided by the client when the resource is created. The
@ -92,10 +98,12 @@ options:
characters must be a dash, lowercase letter, or digit, except the last character,
which cannot be a dash.
required: true
type: str
path_matchers:
description:
- The list of named PathMatchers to use against the URL.
required: false
type: list
suboptions:
default_service:
description:
@ -107,18 +115,22 @@ options:
name-of-resource` to a gcp_compute_backend_service task and then set this
default_service field to "{{ name-of-resource }}"'
required: true
type: dict
description:
description:
- An optional description of this resource.
required: false
type: str
name:
description:
- The name to which this PathMatcher is referred by the HostRule.
required: true
type: str
path_rules:
description:
- The list of path rules.
required: false
type: list
suboptions:
paths:
description:
@ -127,6 +139,7 @@ options:
to the path matcher does not include any text after the first ? or #,
and those chars are not allowed here.'
required: true
type: list
service:
description:
- A reference to the BackendService resource if this rule is matched.
@ -136,24 +149,29 @@ options:
you can add `register: name-of-resource` to a gcp_compute_backend_service
task and then set this service field to "{{ name-of-resource }}"'
required: true
type: dict
tests:
description:
- The list of expected URL mappings. Requests to update this UrlMap will succeed
only if all of the test cases pass.
required: false
type: list
suboptions:
description:
description:
- Description of this test case.
required: false
type: str
host:
description:
- Host portion of the URL.
required: true
type: str
path:
description:
- Path portion of the URL.
required: true
type: str
service:
description:
- A reference to expected BackendService resource the given URL should be
@ -164,6 +182,7 @@ options:
name-of-resource` to a gcp_compute_backend_service task and then set this
service field to "{{ name-of-resource }}"'
required: true
type: dict
extends_documentation_fragment: gcp
'''