From fc561e60d50a687072cafb931ae0693cf3e21889 Mon Sep 17 00:00:00 2001 From: Tomasz Boczkowski Date: Wed, 13 Mar 2019 20:00:07 +0100 Subject: [PATCH 1/2] Add --x-google-api-name argument to legacy get_swagger_spec command. Without the option, the command fails to read parsed arguments. Fixes #189 --- endpoints/_endpointscfg_impl.py | 2 ++ 1 file changed, 2 insertions(+) diff --git a/endpoints/_endpointscfg_impl.py b/endpoints/_endpointscfg_impl.py index e5d97ba..86598a4 100644 --- a/endpoints/_endpointscfg_impl.py +++ b/endpoints/_endpointscfg_impl.py @@ -565,6 +565,8 @@ def AddStandardOptions(parser, *args): get_swagger_spec.set_defaults(callback=_GenOpenApiSpecCallback) 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 From 12658f0b864fdee81306fa321298f8f84a95926d Mon Sep 17 00:00:00 2001 From: Tomasz Boczkowski Date: Fri, 15 Mar 2019 17:53:20 +0100 Subject: [PATCH 2/2] Add deprecation warning to get_swagger_spec command. All users should invoke get_openapi_spec instead. --- endpoints/_endpointscfg_impl.py | 16 +++++++++++++++- 1 file changed, 15 insertions(+), 1 deletion(-) diff --git a/endpoints/_endpointscfg_impl.py b/endpoints/_endpointscfg_impl.py index 86598a4..4db4200 100644 --- a/endpoints/_endpointscfg_impl.py +++ b/endpoints/_endpointscfg_impl.py @@ -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. @@ -562,7 +576,7 @@ 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',