🐛 Flag for including resources in schema

Author: perdy

flama/resources/modules.py

@@ -28,15 +28,17 @@ def add_resource(
         self,
         path: str,
         resource: t.Union[Resource, type[Resource]],
-        tags: t.Optional[dict[str, dict[str, t.Any]]] = None,
         *args,
+        include_in_schema: bool = True,
+        tags: t.Optional[dict[str, dict[str, t.Any]]] = None,
         **kwargs,
     ) -> "Resource":
         """Adds a resource to this application, setting its endpoints.
 
         :param path: Resource base path.
-        :param tags: Tags to add to the resource.
         :param resource: Resource class.
+        :param include_in_schema: True if this route or endpoint should be declared as part of the API schema.
+        :param tags: Tags to add to the resource.
         """
         if inspect.isclass(resource) and issubclass(resource, Resource):
             resource_instance = resource(*args, **kwargs)
@@ -45,20 +47,28 @@ def add_resource(
         else:
             raise ValueError("Wrong resource")
 
-        self.app.mount(mount=ResourceRoute(path, resource_instance, tags))
+        self.app.mount(mount=ResourceRoute(path, resource_instance, include_in_schema=include_in_schema, tags=tags))
 
         return resource_instance
 
-    def resource(self, path: str, tags: t.Optional[dict[str, dict[str, t.Any]]] = None, *args, **kwargs) -> t.Callable:
+    def resource(
+        self,
+        path: str,
+        *args,
+        include_in_schema: bool = True,
+        tags: t.Optional[dict[str, dict[str, t.Any]]] = None,
+        **kwargs,
+    ) -> t.Callable:
         """Decorator for Resources classes for adding them to the application.
 
         :param path: Resource base path.
+        :param include_in_schema: True if this route or endpoint should be declared as part of the API schema.
         :param tags: Tags to add to the resource.
         :return: Decorated resource class.
         """
 
         def decorator(resource: type[Resource]) -> type[Resource]:
-            self.add_resource(path, resource, tags, *args, **kwargs)
+            self.add_resource(path, resource, *args, include_in_schema=include_in_schema, tags=tags, **kwargs)
             return resource
 
         return decorator

flama/resources/routing.py

@@ -18,6 +18,8 @@ def __init__(
         self,
         path: str,
         resource: t.Union["Resource", type["Resource"]],
+        *,
+        include_in_schema: bool = True,
         tags: t.Optional[dict[str, t.Any]] = None,
     ):
         tags = tags or {}
@@ -34,7 +36,7 @@ def __init__(
                 endpoint=getattr(self.resource, name),
                 methods=route._meta.methods,
                 name=route._meta.name or route.__name__,
-                include_in_schema=route._meta.include_in_schema,
+                include_in_schema=include_in_schema and route._meta.include_in_schema,
                 tags=tags.get(name, route._meta.tags),
                 pagination=route._meta.pagination,
             )

tests/resources/test_routing.py

@@ -168,12 +168,15 @@ async def list(self):
             assert response.status_code == 200
 
     def test_method(self):
-        @ResourceRoute.method(path="/", methods=["POST"], name="foo", tags={"additional": "bar"})
+        @ResourceRoute.method(
+            path="/", methods=["POST"], name="foo", include_in_schema=False, tags={"additional": "bar"}
+        )
         def foo(x: int):
             return x
 
         assert hasattr(foo, "_meta")
         assert foo._meta.path == "/"
         assert foo._meta.methods == {"POST"}
         assert foo._meta.name == "foo"
+        assert foo._meta.include_in_schema is False
         assert foo._meta.tags == {"additional": "bar"}