Skip to content

Add --x-google-api-name argument to legacy get_swagger_spec command. #190

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add --x-google-api-name argument to legacy get_swagger_spec command. #190

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
fc561e6
Add --x-google-api-name argument to legacy get_swagger_spec command.
tomboc Mar 13, 2019
12658f0
Add deprecation warning to get_swagger_spec command.
tomboc Mar 15, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion endpoints/_endpointscfg_impl.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -467,6 +467,20 @@ def _GenOpenApiSpecCallback(args, openapi_func=_GenOpenApiSpec):
print 'OpenAPI spec written to %s' % openapi_path


def _GenSwaggerSpecCallback(args):
"""Generate OpenAPI (Swagger) specs to files [DEPRECATED].

This is a deprecated command generating OpenAPI (Swagger) specs. Use
get_openapi_spec instead.

Args:
args: An argparse.Namespace object to extract parameters from.
"""
print "WARNING: gen_swagger_spec is deprecated."
print "WARNING: Use get_openapi_spec instead."
_GenOpenApiSpecCallback(args)


def _GenClientLibCallback(args, client_func=_GenClientLib):
"""Generate a client library to file.

Expand Down Expand Up @@ -562,9 +576,11 @@ def AddStandardOptions(parser, *args):
get_swagger_spec = subparsers.add_parser(
'get_swagger_spec',
help='Generates OpenAPI (Swagger) specs from service classes')
get_swagger_spec.set_defaults(callback=_GenOpenApiSpecCallback)
get_swagger_spec.set_defaults(callback=_GenSwaggerSpecCallback)
AddStandardOptions(get_swagger_spec, 'application', 'hostname', 'output',
'service')
get_swagger_spec.add_argument('--x-google-api-name', action='store_true',
help="Add the 'x-google-api-name' field to the generated spec")

# By removing the help attribute, the following three actions won't be
# displayed in usage message
Expand Down