Document endpoint tags

aio-libs · Dec 16, 2024 · 421874d · 421874d
1 parent 463621f
commit 421874d
Showing 1 changed file with 11 additions and 0 deletions.
diff --git a/docs/index.rst b/docs/index.rst
@@ -88,6 +88,17 @@ You can use docstrings to customise the summary and description shown in the sch
         description.
         """
 
+Group endpoints using tags
+++++++++++++++++++++++++++
+
+Both :code:`api` and :code:`api_view` decorators allow to specify endpoint tags which group endpoints in the schema:
+
+.. code-block:: python
+
+    @SCHEMA.api(tags=["Bar"])
+    async def foo(request: web.Request) -> APIResponse[list[str], Literal[200]]:
+        return APIResponse(["foo"])
+
 Library Installation
 --------------------