Minor docs changes for UrlMap

This commit is contained in:
Riley Karson 2018-10-12 23:02:26 +00:00 committed by Alex Stephen
parent 19b40a3240
commit 6f1eb02314
2 changed files with 9 additions and 8 deletions

View file

@ -112,7 +112,7 @@ options:
suboptions: suboptions:
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this HostRule. Provide this property when you create
the resource. the resource.
required: false required: false
hosts: hosts:
@ -168,7 +168,7 @@ options:
- 'The list of path patterns to match. Each must start with / and the only place a - 'The list of path patterns to match. Each must start with / and the only place a
* is allowed is at the end following a /. The string fed to the path matcher does * is allowed is at the end following a /. The string fed to the path matcher does
not include any text after the first ? or #, and those chars are not allowed here.' not include any text after the first ? or #, and those chars are not allowed here.'
required: false required: true
service: service:
description: description:
- A reference to the BackendService resource if this rule is matched. - A reference to the BackendService resource if this rule is matched.
@ -180,7 +180,8 @@ options:
required: true required: true
tests: tests:
description: description:
- Description of this test case. - The list of expected URL mappings. Requests to update this UrlMap will succeed only
if all of the test cases pass.
required: false required: false
suboptions: suboptions:
description: description:
@ -280,7 +281,7 @@ RETURN = '''
contains: contains:
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this HostRule. Provide this property when you create
the resource. the resource.
returned: success returned: success
type: str type: str
@ -360,7 +361,7 @@ RETURN = '''
type: dict type: dict
tests: tests:
description: description:
- The list of expected URL mappings. Request to update this UrlMap will succeed only - The list of expected URL mappings. Requests to update this UrlMap will succeed only
if all of the test cases pass. if all of the test cases pass.
returned: success returned: success
type: complex type: complex
@ -419,7 +420,7 @@ def main():
description=dict(type='str'), description=dict(type='str'),
name=dict(required=True, type='str'), name=dict(required=True, type='str'),
path_rules=dict(type='list', elements='dict', options=dict( path_rules=dict(type='list', elements='dict', options=dict(
paths=dict(type='list', elements='str'), paths=dict(required=True, type='list', elements='str'),
service=dict(required=True, type='dict') service=dict(required=True, type='dict')
)) ))
)), )),

View file

@ -88,7 +88,7 @@ items:
contains: contains:
description: description:
description: description:
- An optional description of this resource. Provide this property when you create - An optional description of this HostRule. Provide this property when you create
the resource. the resource.
returned: success returned: success
type: str type: str
@ -168,7 +168,7 @@ items:
type: dict type: dict
tests: tests:
description: description:
- The list of expected URL mappings. Request to update this UrlMap will succeed only - The list of expected URL mappings. Requests to update this UrlMap will succeed only
if all of the test cases pass. if all of the test cases pass.
returned: success returned: success
type: complex type: complex