generate the sidebar (#3414) (#206)

* generate the sidebar

* put back accidentally deleted lines

* whitespace

* empty commit

Signed-off-by: Modular Magician <magic-modules@google.com>
This commit is contained in:
The Magician 2020-04-23 19:38:42 -04:00 committed by GitHub
parent 5cf411fd03
commit 41c072bf28
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 171 additions and 109 deletions

View file

@ -872,38 +872,45 @@ options:
https_redirect: https_redirect:
description: description:
- If set to true, the URL scheme in the redirected request is set - If set to true, the URL scheme in the redirected request is set
to https. If set to false, the URL scheme of the redirected request to https.
will remain the same as that of the request. This must only be set - If set to false, the URL scheme of the redirected request will remain
for UrlMaps used in TargetHttpProxys. the same as that of the request. This must only be set for UrlMaps
- Setting this true for TargetHttpsProxy is not permitted. Defaults used in TargetHttpProxys. Setting this true for TargetHttpsProxy
to false. is not permitted. The default is set to false.
required: false required: false
default: 'false' default: 'false'
type: bool type: bool
path_redirect: path_redirect:
description: description:
- The path that will be used in the redirect response instead of the - The path that will be used in the redirect response instead of the
one that was supplied in the request. Only one of pathRedirect or one that was supplied in the request. pathRedirect cannot be supplied
prefixRedirect must be specified. The value must be between 1 and together with prefixRedirect. Supply one alone or neither. If neither
1024 characters. is supplied, the path of the original request will be used for the
redirect.
- The value must be between 1 and 1024 characters.
required: false required: false
type: str type: str
prefix_redirect: prefix_redirect:
description: description:
- The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, - The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting the retaining the remaining portion of the URL before redirecting the
request. request. prefixRedirect cannot be supplied together with pathRedirect.
Supply one alone or neither. If neither is supplied, the path of
the original request will be used for the redirect. The value must
be between 1 and 1024 characters.
required: false required: false
type: str type: str
redirect_response_code: redirect_response_code:
description: description:
- 'The HTTP Status code to use for this RedirectAction. Supported - 'The HTTP Status code to use for this RedirectAction. Supported
values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value values are: - MOVED_PERMANENTLY_DEFAULT, which is the default value
and corresponds to 301. - FOUND, which corresponds to 302. - SEE_OTHER and corresponds to 301.'
which corresponds to 303. - TEMPORARY_REDIRECT, which corresponds - "- FOUND, which corresponds to 302."
to 307. In this case, the request method will be retained. - PERMANENT_REDIRECT, - "- SEE_OTHER which corresponds to 303."
which corresponds to 308. In this case, the request method will - "- TEMPORARY_REDIRECT, which corresponds to 307. In this case, the
be retained.' request method will be retained."
- "- PERMANENT_REDIRECT, which corresponds to 308. In this case, the
request method will be retained."
- 'Some valid choices include: "FOUND", "MOVED_PERMANENTLY_DEFAULT", - 'Some valid choices include: "FOUND", "MOVED_PERMANENTLY_DEFAULT",
"PERMANENT_REDIRECT", "SEE_OTHER", "TEMPORARY_REDIRECT"' "PERMANENT_REDIRECT", "SEE_OTHER", "TEMPORARY_REDIRECT"'
required: false required: false
@ -912,7 +919,8 @@ options:
description: description:
- If set to true, any accompanying query portion of the original URL - If set to true, any accompanying query portion of the original URL
is removed prior to redirecting the request. If set to false, the is removed prior to redirecting the request. If set to false, the
query portion of the original URL is retained. Defaults to false. query portion of the original URL is retained. The default is set
to false.
required: false required: false
default: 'false' default: 'false'
type: bool type: bool
@ -1355,27 +1363,32 @@ options:
https_redirect: https_redirect:
description: description:
- If set to true, the URL scheme in the redirected request is set - If set to true, the URL scheme in the redirected request is set
to https. If set to false, the URL scheme of the redirected request to https.
will remain the same as that of the request. This must only be set - If set to false, the URL scheme of the redirected request will remain
for UrlMaps used in TargetHttpProxys. the same as that of the request. This must only be set for UrlMaps
- Setting this true for TargetHttpsProxy is not permitted. Defaults used in TargetHttpProxys. Setting this true for TargetHttpsProxy
to false. is not permitted. The default is set to false.
required: false required: false
default: 'false' default: 'false'
type: bool type: bool
path_redirect: path_redirect:
description: description:
- The path that will be used in the redirect response instead of the - The path that will be used in the redirect response instead of the
one that was supplied in the request. Only one of pathRedirect or one that was supplied in the request. pathRedirect cannot be supplied
prefixRedirect must be specified. The value must be between 1 and together with prefixRedirect. Supply one alone or neither. If neither
1024 characters. is supplied, the path of the original request will be used for the
redirect.
- The value must be between 1 and 1024 characters.
required: false required: false
type: str type: str
prefix_redirect: prefix_redirect:
description: description:
- The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, - The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting the retaining the remaining portion of the URL before redirecting the
request. request. prefixRedirect cannot be supplied together with pathRedirect.
Supply one alone or neither. If neither is supplied, the path of
the original request will be used for the redirect. The value must
be between 1 and 1024 characters.
required: false required: false
type: str type: str
redirect_response_code: redirect_response_code:
@ -1397,8 +1410,10 @@ options:
description: description:
- If set to true, any accompanying query portion of the original URL - If set to true, any accompanying query portion of the original URL
is removed prior to redirecting the request. If set to false, the is removed prior to redirecting the request. If set to false, the
query portion of the original URL is retained. query portion of the original URL is retained. The default is set
required: true to false.
required: false
default: 'false'
type: bool type: bool
tests: tests:
description: description:
@ -2292,43 +2307,52 @@ pathMatchers:
httpsRedirect: httpsRedirect:
description: description:
- If set to true, the URL scheme in the redirected request is set to - If set to true, the URL scheme in the redirected request is set to
https. If set to false, the URL scheme of the redirected request will https.
remain the same as that of the request. This must only be set for - If set to false, the URL scheme of the redirected request will remain
UrlMaps used in TargetHttpProxys. the same as that of the request. This must only be set for UrlMaps
- Setting this true for TargetHttpsProxy is not permitted. Defaults used in TargetHttpProxys. Setting this true for TargetHttpsProxy is
to false. not permitted. The default is set to false.
returned: success returned: success
type: bool type: bool
pathRedirect: pathRedirect:
description: description:
- The path that will be used in the redirect response instead of the - The path that will be used in the redirect response instead of the
one that was supplied in the request. Only one of pathRedirect or one that was supplied in the request. pathRedirect cannot be supplied
prefixRedirect must be specified. The value must be between 1 and together with prefixRedirect. Supply one alone or neither. If neither
1024 characters. is supplied, the path of the original request will be used for the
redirect.
- The value must be between 1 and 1024 characters.
returned: success returned: success
type: str type: str
prefixRedirect: prefixRedirect:
description: description:
- The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, - The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting the retaining the remaining portion of the URL before redirecting the
request. request. prefixRedirect cannot be supplied together with pathRedirect.
Supply one alone or neither. If neither is supplied, the path of the
original request will be used for the redirect. The value must be
between 1 and 1024 characters.
returned: success returned: success
type: str type: str
redirectResponseCode: redirectResponseCode:
description: description:
- 'The HTTP Status code to use for this RedirectAction. Supported values - 'The HTTP Status code to use for this RedirectAction. Supported values
are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds are: - MOVED_PERMANENTLY_DEFAULT, which is the default value and corresponds
to 301. - FOUND, which corresponds to 302. - SEE_OTHER which corresponds to 301.'
to 303. - TEMPORARY_REDIRECT, which corresponds to 307. In this case, - "- FOUND, which corresponds to 302."
the request method will be retained. - PERMANENT_REDIRECT, which corresponds - "- SEE_OTHER which corresponds to 303."
to 308. In this case, the request method will be retained.' - "- TEMPORARY_REDIRECT, which corresponds to 307. In this case, the
request method will be retained."
- "- PERMANENT_REDIRECT, which corresponds to 308. In this case, the
request method will be retained."
returned: success returned: success
type: str type: str
stripQuery: stripQuery:
description: description:
- If set to true, any accompanying query portion of the original URL - If set to true, any accompanying query portion of the original URL
is removed prior to redirecting the request. If set to false, the is removed prior to redirecting the request. If set to false, the
query portion of the original URL is retained. Defaults to false. query portion of the original URL is retained. The default is set
to false.
returned: success returned: success
type: bool type: bool
pathRules: pathRules:
@ -2732,26 +2756,31 @@ pathMatchers:
httpsRedirect: httpsRedirect:
description: description:
- If set to true, the URL scheme in the redirected request is set to - If set to true, the URL scheme in the redirected request is set to
https. If set to false, the URL scheme of the redirected request will https.
remain the same as that of the request. This must only be set for - If set to false, the URL scheme of the redirected request will remain
UrlMaps used in TargetHttpProxys. the same as that of the request. This must only be set for UrlMaps
- Setting this true for TargetHttpsProxy is not permitted. Defaults used in TargetHttpProxys. Setting this true for TargetHttpsProxy is
to false. not permitted. The default is set to false.
returned: success returned: success
type: bool type: bool
pathRedirect: pathRedirect:
description: description:
- The path that will be used in the redirect response instead of the - The path that will be used in the redirect response instead of the
one that was supplied in the request. Only one of pathRedirect or one that was supplied in the request. pathRedirect cannot be supplied
prefixRedirect must be specified. The value must be between 1 and together with prefixRedirect. Supply one alone or neither. If neither
1024 characters. is supplied, the path of the original request will be used for the
redirect.
- The value must be between 1 and 1024 characters.
returned: success returned: success
type: str type: str
prefixRedirect: prefixRedirect:
description: description:
- The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, - The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting the retaining the remaining portion of the URL before redirecting the
request. request. prefixRedirect cannot be supplied together with pathRedirect.
Supply one alone or neither. If neither is supplied, the path of the
original request will be used for the redirect. The value must be
between 1 and 1024 characters.
returned: success returned: success
type: str type: str
redirectResponseCode: redirectResponseCode:
@ -2771,7 +2800,8 @@ pathMatchers:
description: description:
- If set to true, any accompanying query portion of the original URL - If set to true, any accompanying query portion of the original URL
is removed prior to redirecting the request. If set to false, the is removed prior to redirecting the request. If set to false, the
query portion of the original URL is retained. query portion of the original URL is retained. The default is set
to false.
returned: success returned: success
type: bool type: bool
tests: tests:
@ -3119,7 +3149,7 @@ def main():
path_redirect=dict(type='str'), path_redirect=dict(type='str'),
prefix_redirect=dict(type='str'), prefix_redirect=dict(type='str'),
redirect_response_code=dict(type='str'), redirect_response_code=dict(type='str'),
strip_query=dict(required=True, type='bool'), strip_query=dict(type='bool'),
), ),
), ),
), ),

View file

@ -908,45 +908,52 @@ resources:
httpsRedirect: httpsRedirect:
description: description:
- If set to true, the URL scheme in the redirected request is set - If set to true, the URL scheme in the redirected request is set
to https. If set to false, the URL scheme of the redirected request to https.
will remain the same as that of the request. This must only be - If set to false, the URL scheme of the redirected request will
set for UrlMaps used in TargetHttpProxys. remain the same as that of the request. This must only be set
- Setting this true for TargetHttpsProxy is not permitted. Defaults for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy
to false. is not permitted. The default is set to false.
returned: success returned: success
type: bool type: bool
pathRedirect: pathRedirect:
description: description:
- The path that will be used in the redirect response instead of - The path that will be used in the redirect response instead of
the one that was supplied in the request. Only one of pathRedirect the one that was supplied in the request. pathRedirect cannot
or prefixRedirect must be specified. The value must be between be supplied together with prefixRedirect. Supply one alone or
1 and 1024 characters. neither. If neither is supplied, the path of the original request
will be used for the redirect.
- The value must be between 1 and 1024 characters.
returned: success returned: success
type: str type: str
prefixRedirect: prefixRedirect:
description: description:
- The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, - The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting retaining the remaining portion of the URL before redirecting
the request. the request. prefixRedirect cannot be supplied together with pathRedirect.
Supply one alone or neither. If neither is supplied, the path
of the original request will be used for the redirect. The value
must be between 1 and 1024 characters.
returned: success returned: success
type: str type: str
redirectResponseCode: redirectResponseCode:
description: description:
- 'The HTTP Status code to use for this RedirectAction. Supported - 'The HTTP Status code to use for this RedirectAction. Supported
values are: - MOVED_PERMANENTLY_DEFAULT, which is the default values are: - MOVED_PERMANENTLY_DEFAULT, which is the default
value and corresponds to 301. - FOUND, which corresponds to 302. value and corresponds to 301.'
- SEE_OTHER which corresponds to 303. - TEMPORARY_REDIRECT, which - "- FOUND, which corresponds to 302."
corresponds to 307. In this case, the request method will be retained. - "- SEE_OTHER which corresponds to 303."
- PERMANENT_REDIRECT, which corresponds to 308. In this case, - "- TEMPORARY_REDIRECT, which corresponds to 307. In this case,
the request method will be retained.' the request method will be retained."
- "- PERMANENT_REDIRECT, which corresponds to 308. In this case,
the request method will be retained."
returned: success returned: success
type: str type: str
stripQuery: stripQuery:
description: description:
- If set to true, any accompanying query portion of the original - If set to true, any accompanying query portion of the original
URL is removed prior to redirecting the request. If set to false, URL is removed prior to redirecting the request. If set to false,
the query portion of the original URL is retained. Defaults to the query portion of the original URL is retained. The default
false. is set to false.
returned: success returned: success
type: bool type: bool
pathRules: pathRules:
@ -1362,26 +1369,31 @@ resources:
httpsRedirect: httpsRedirect:
description: description:
- If set to true, the URL scheme in the redirected request is set - If set to true, the URL scheme in the redirected request is set
to https. If set to false, the URL scheme of the redirected request to https.
will remain the same as that of the request. This must only be - If set to false, the URL scheme of the redirected request will
set for UrlMaps used in TargetHttpProxys. remain the same as that of the request. This must only be set
- Setting this true for TargetHttpsProxy is not permitted. Defaults for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy
to false. is not permitted. The default is set to false.
returned: success returned: success
type: bool type: bool
pathRedirect: pathRedirect:
description: description:
- The path that will be used in the redirect response instead of - The path that will be used in the redirect response instead of
the one that was supplied in the request. Only one of pathRedirect the one that was supplied in the request. pathRedirect cannot
or prefixRedirect must be specified. The value must be between be supplied together with prefixRedirect. Supply one alone or
1 and 1024 characters. neither. If neither is supplied, the path of the original request
will be used for the redirect.
- The value must be between 1 and 1024 characters.
returned: success returned: success
type: str type: str
prefixRedirect: prefixRedirect:
description: description:
- The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, - The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting retaining the remaining portion of the URL before redirecting
the request. the request. prefixRedirect cannot be supplied together with pathRedirect.
Supply one alone or neither. If neither is supplied, the path
of the original request will be used for the redirect. The value
must be between 1 and 1024 characters.
returned: success returned: success
type: str type: str
redirectResponseCode: redirectResponseCode:
@ -1401,7 +1413,8 @@ resources:
description: description:
- If set to true, any accompanying query portion of the original - If set to true, any accompanying query portion of the original
URL is removed prior to redirecting the request. If set to false, URL is removed prior to redirecting the request. If set to false,
the query portion of the original URL is retained. the query portion of the original URL is retained. The default
is set to false.
returned: success returned: success
type: bool type: bool
tests: tests:

View file

@ -736,27 +736,32 @@ options:
https_redirect: https_redirect:
description: description:
- If set to true, the URL scheme in the redirected request is set - If set to true, the URL scheme in the redirected request is set
to https. If set to false, the URL scheme of the redirected request to https.
will remain the same as that of the request. This must only be set - If set to false, the URL scheme of the redirected request will remain
for UrlMaps used in TargetHttpProxys. the same as that of the request. This must only be set for UrlMaps
- Setting this true for TargetHttpsProxy is not permitted. Defaults used in TargetHttpProxys. Setting this true for TargetHttpsProxy
to false. is not permitted. The default is set to false.
required: false required: false
default: 'false' default: 'false'
type: bool type: bool
path_redirect: path_redirect:
description: description:
- The path that will be used in the redirect response instead of the - The path that will be used in the redirect response instead of the
one that was supplied in the request. Only one of pathRedirect or one that was supplied in the request. pathRedirect cannot be supplied
prefixRedirect must be specified. The value must be between 1 and together with prefixRedirect. Supply one alone or neither. If neither
1024 characters. is supplied, the path of the original request will be used for the
redirect.
- The value must be between 1 and 1024 characters.
required: false required: false
type: str type: str
prefix_redirect: prefix_redirect:
description: description:
- The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, - The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting the retaining the remaining portion of the URL before redirecting the
request. request. prefixRedirect cannot be supplied together with pathRedirect.
Supply one alone or neither. If neither is supplied, the path of
the original request will be used for the redirect. The value must
be between 1 and 1024 characters.
required: false required: false
type: str type: str
redirect_response_code: redirect_response_code:
@ -778,8 +783,10 @@ options:
description: description:
- If set to true, any accompanying query portion of the original URL - If set to true, any accompanying query portion of the original URL
is removed prior to redirecting the request. If set to false, the is removed prior to redirecting the request. If set to false, the
query portion of the original URL is retained. query portion of the original URL is retained. The default is set
required: true to false.
required: false
default: 'false'
type: bool type: bool
route_rules: route_rules:
description: description:
@ -2343,26 +2350,31 @@ pathMatchers:
httpsRedirect: httpsRedirect:
description: description:
- If set to true, the URL scheme in the redirected request is set to - If set to true, the URL scheme in the redirected request is set to
https. If set to false, the URL scheme of the redirected request will https.
remain the same as that of the request. This must only be set for - If set to false, the URL scheme of the redirected request will remain
UrlMaps used in TargetHttpProxys. the same as that of the request. This must only be set for UrlMaps
- Setting this true for TargetHttpsProxy is not permitted. Defaults used in TargetHttpProxys. Setting this true for TargetHttpsProxy is
to false. not permitted. The default is set to false.
returned: success returned: success
type: bool type: bool
pathRedirect: pathRedirect:
description: description:
- The path that will be used in the redirect response instead of the - The path that will be used in the redirect response instead of the
one that was supplied in the request. Only one of pathRedirect or one that was supplied in the request. pathRedirect cannot be supplied
prefixRedirect must be specified. The value must be between 1 and together with prefixRedirect. Supply one alone or neither. If neither
1024 characters. is supplied, the path of the original request will be used for the
redirect.
- The value must be between 1 and 1024 characters.
returned: success returned: success
type: str type: str
prefixRedirect: prefixRedirect:
description: description:
- The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, - The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting the retaining the remaining portion of the URL before redirecting the
request. request. prefixRedirect cannot be supplied together with pathRedirect.
Supply one alone or neither. If neither is supplied, the path of the
original request will be used for the redirect. The value must be
between 1 and 1024 characters.
returned: success returned: success
type: str type: str
redirectResponseCode: redirectResponseCode:
@ -2382,7 +2394,8 @@ pathMatchers:
description: description:
- If set to true, any accompanying query portion of the original URL - If set to true, any accompanying query portion of the original URL
is removed prior to redirecting the request. If set to false, the is removed prior to redirecting the request. If set to false, the
query portion of the original URL is retained. query portion of the original URL is retained. The default is set
to false.
returned: success returned: success
type: bool type: bool
routeRules: routeRules:
@ -3331,7 +3344,7 @@ def main():
path_redirect=dict(type='str'), path_redirect=dict(type='str'),
prefix_redirect=dict(type='str'), prefix_redirect=dict(type='str'),
redirect_response_code=dict(type='str'), redirect_response_code=dict(type='str'),
strip_query=dict(required=True, type='bool'), strip_query=dict(type='bool'),
), ),
), ),
), ),

View file

@ -765,26 +765,31 @@ resources:
httpsRedirect: httpsRedirect:
description: description:
- If set to true, the URL scheme in the redirected request is set - If set to true, the URL scheme in the redirected request is set
to https. If set to false, the URL scheme of the redirected request to https.
will remain the same as that of the request. This must only be - If set to false, the URL scheme of the redirected request will
set for UrlMaps used in TargetHttpProxys. remain the same as that of the request. This must only be set
- Setting this true for TargetHttpsProxy is not permitted. Defaults for UrlMaps used in TargetHttpProxys. Setting this true for TargetHttpsProxy
to false. is not permitted. The default is set to false.
returned: success returned: success
type: bool type: bool
pathRedirect: pathRedirect:
description: description:
- The path that will be used in the redirect response instead of - The path that will be used in the redirect response instead of
the one that was supplied in the request. Only one of pathRedirect the one that was supplied in the request. pathRedirect cannot
or prefixRedirect must be specified. The value must be between be supplied together with prefixRedirect. Supply one alone or
1 and 1024 characters. neither. If neither is supplied, the path of the original request
will be used for the redirect.
- The value must be between 1 and 1024 characters.
returned: success returned: success
type: str type: str
prefixRedirect: prefixRedirect:
description: description:
- The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch, - The prefix that replaces the prefixMatch specified in the HttpRouteRuleMatch,
retaining the remaining portion of the URL before redirecting retaining the remaining portion of the URL before redirecting
the request. the request. prefixRedirect cannot be supplied together with pathRedirect.
Supply one alone or neither. If neither is supplied, the path
of the original request will be used for the redirect. The value
must be between 1 and 1024 characters.
returned: success returned: success
type: str type: str
redirectResponseCode: redirectResponseCode:
@ -804,7 +809,8 @@ resources:
description: description:
- If set to true, any accompanying query portion of the original - If set to true, any accompanying query portion of the original
URL is removed prior to redirecting the request. If set to false, URL is removed prior to redirecting the request. If set to false,
the query portion of the original URL is retained. the query portion of the original URL is retained. The default
is set to false.
returned: success returned: success
type: bool type: bool
routeRules: routeRules: