Enabling hidden APIs in flask-rebar (plangrid#191)

* testing repo access https://jira.autodesk.com/browse/PGC-1520cd .. * testing repo access https://jira.autodesk.com/browse/PGC-1520cd .. * Enabling hidden APIs in flask-rebar https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * Enabling hidden APIs in flask-rebar https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * Enabling hidden APIs in flask-rebar https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * Control full private/public swagger doc generation https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * Responding to PR feedback https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * changing hidden api logic https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * adding test coverage (plangrid#201) * adding test coverage https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * test coverage fixes https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * Test coverage https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * clean up https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * clean up https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * clean up from pr comments https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141 * pr comment changes https://jira.autodesk.com/browse/ACSBP-1520 plangrid#141
dekim24 · Aug 21, 2020 · 3cce2d6 · 3cce2d6
1 parent d56e688
commit 3cce2d6
Show file tree

Hide file tree

Showing 6 changed files with 713 additions and 1 deletion.
diff --git a/flask_rebar/rebar.py b/flask_rebar/rebar.py
@@ -239,6 +239,7 @@ class PathDefinition(
             "authenticators",
             "tags",
             "mimetype",
+            "hidden",
         ],
     )
 ):
@@ -410,6 +411,7 @@ def paths(self):
                     authenticators=definition_.authenticators,
                     tags=definition_.tags,
                     mimetype=definition_.mimetype,
+                    hidden=definition_.hidden,
                 )
 
         return paths
@@ -435,6 +437,7 @@ def add_handler(
         authenticators=USE_DEFAULT,
         tags=None,
         mimetype=USE_DEFAULT,
+        hidden=False,
     ):
         """
         Registers a function as a request handler.
@@ -464,6 +467,8 @@ def add_handler(
             Arbitrary strings to tag the handler with. These will translate to Swagger operation tags.
         :param Type[USE_DEFAULT]|None|str mimetype:
             Content-Type header to add to the response schema
+        :param bool hidden:
+            if hidden, documentation is not created for this request handler by default
         """
         # Fix #115: if we were passed bare classes we'll go ahead and instantiate
         headers_schema = normalize_schema(headers_schema)
@@ -497,6 +502,7 @@ def add_handler(
             authenticators=authenticators,
             tags=tags,
             mimetype=mimetype,
+            hidden=hidden,
         )
 
     @deprecated_parameters(
@@ -519,6 +525,7 @@ def handles(
         authenticators=USE_DEFAULT,
         tags=None,
         mimetype=USE_DEFAULT,
+        hidden=False,
     ):
         """
         Same arguments as :meth:`HandlerRegistry.add_handler`, except this can
@@ -538,6 +545,7 @@ def wrapper(f):
                 authenticators=authenticators,
                 tags=tags,
                 mimetype=mimetype,
+                hidden=hidden,
             )
             return f
 

diff --git a/flask_rebar/swagger_generation/swagger_generator_base.py b/flask_rebar/swagger_generation/swagger_generator_base.py
@@ -117,7 +117,9 @@ def __init__(
         response_converter_registry=None,
         default_response_schema=Error(),
         authenticator_converter_registry=None,
+        include_hidden=False,
     ):
+        self.include_hidden = include_hidden
         self.title = title
         self.version = version
         self.description = description

diff --git a/flask_rebar/swagger_generation/swagger_generator_v3.py b/flask_rebar/swagger_generation/swagger_generator_v3.py
@@ -64,7 +64,9 @@ def __init__(
         servers=None,
         default_response_schema=Error(),
         authenticator_converter_registry=None,
+        include_hidden=False,
     ):
+
         super(SwaggerV3Generator, self).__init__(
             openapi_major_version=3,
             version=version,
@@ -76,6 +78,7 @@ def __init__(
             headers_converter_registry=headers_converter_registry,
             response_converter_registry=response_converter_registry,
             authenticator_converter_registry=authenticator_converter_registry,
+            include_hidden=include_hidden,
         )
         self.tags = tags
         self.servers = servers
@@ -139,6 +142,11 @@ def _get_paths(self, paths, default_headers_schema, default_security=None):
         for path, methods in paths.items():
             swagger_path, path_args = format_path_for_swagger(path)
 
+            if not self.include_hidden and all(
+                d.hidden for method, d in methods.items()
+            ):
+                continue
+
             # Different Flask paths might correspond to the same Swagger path
             # because of Flask URL path converters. In this case, let's just
             # work off the same path definitions.

diff --git a/setup.py b/setup.py
@@ -12,7 +12,6 @@
     "bumpversion==0.5.3",
     "gitchangelog>=3.0.4,<4.0.0",
     "pre-commit>=1.14.4",
-    "pyyaml",
 ]
 
 if __name__ == "__main__":