doc: fill

Author: emptybutton

README.md

@@ -5,7 +5,7 @@
 [![Lines](https://img.shields.io/endpoint?url=https%3A%2F%2Fghloc.vercel.app%2Fapi%2Femptybutton%2Ftgdb%2Fbadge%3Ffilter%3D.py&logo=python&label=lines&color=blue)](https://github.com/search?q=repo%3Aemptybutton%2tgdb+language%3APython+&type=code)
 [![Wakatime](https://wakatime.com/badge/user/0d3b7ff5-0547-4323-a43e-2a7308d973a0/project/2e316b92-fcf1-44d8-ad77-6c81e23cdfe2.svg)](https://wakatime.com/badge/user/0d3b7ff5-0547-4323-a43e-2a7308d973a0/project/2e316b92-fcf1-44d8-ad77-6c81e23cdfe2)
 
-РСУБД поверх телеграмма.
+РСУБД поверх Telegram.
 
 ```bash
 pip install tgdb

src/tgdb/presentation/fastapi/common/app.py

@@ -84,7 +84,9 @@ async def app_from(container: AsyncContainer) -> FastAPI:
         version=version,
         summary="RDBMS over Telegram.",
         openapi_tags=tags_metadata,
-        contact={"name": "Alexander Smolin", "url": author_url},
+        contact={
+            "name": "Alexander Smolin", "url": author_url,
+        },
         license_info={
             "name": "Apache 2.0",
             "url": f"{repo_url}/blob/main/LICENSE",
@@ -103,4 +105,10 @@ async def app_from(container: AsyncContainer) -> FastAPI:
     setup_dishka(container=container, app=app)
     add_error_handling(app)
 
+    openapi = app.openapi()
+    openapi["externalDocs"] = {
+        "description": "Github",
+        "url": repo_url,
+    }
+
     return app

src/tgdb/presentation/fastapi/horizon/routes/commit_transaction.py

@@ -21,19 +21,6 @@
 
 commit_transaction_router = APIRouter()
 
-description = """
-Record all transaction operators and commit them.
-
-A transaction may fail to commit in the following cases:
-1. It is a serializable transaction that conflicts with another serializable transaction.
-2. The server runs out of space for active transactions and rolls back your transaction.
-3. The transaction rolled back due to timeout.
-4. The server crashes.
-
-If the commit fails, all changes in the transaction will not be applied.
-Therefore, for any negative response, retry the entire transaction.
-"""  # noqa: E501
-
 
 class CommitTransactionSchema(BaseModel):
     operators: tuple[OperatorSchema, ...]
@@ -51,7 +38,7 @@ class CommitTransactionSchema(BaseModel):
         status.HTTP_409_CONFLICT: {"model": TransactionConflictSchema},
     },
     summary="Commit transaction",
-    description=description,
+    description="Record all transaction operators and commit them.",
     tags=[Tag.transaction],
 )
 @inject

src/tgdb/presentation/fastapi/horizon/routes/rollback_transaction.py

@@ -13,13 +13,6 @@
 
 rollback_transaction_router = APIRouter()
 
-description = """
-Roll back the transaction as if it had never started.
-
-If the transaction cannot be rolled back, it will be rolled back automatically
-over time.
-"""
-
 
 @rollback_transaction_router.delete(
     "/transactions/{xid}",
@@ -30,7 +23,7 @@
         status.HTTP_404_NOT_FOUND: {"model": NoTransactionSchema},
     },
     summary="Rollback transaction",
-    description=description,
+    description="Rollback a transaction as if it had never started.",
     tags=[Tag.transaction],
 )
 @inject

src/tgdb/presentation/fastapi/horizon/routes/start_transaction.py

@@ -29,7 +29,7 @@ class StartedTransactionSchema(BaseModel):
         status.HTTP_201_CREATED: {"model": StartedTransactionSchema},
     },
     summary="Start transaction",
-    description="Start transaction.",
+    description="Start new transaction.",
     tags=[Tag.transaction],
 )
 @inject

src/tgdb/presentation/fastapi/relation/routes/view_tuples.py

@@ -50,7 +50,7 @@ def of(cls, tuples: Iterable[Tuple]) -> "ViewedTuplesSchema":
         },
     },
     summary="View tuples",
-    description="View tuples in an active transaction.",
+    description="View tuples, optionally in an active transaction.",
     tags=[Tag.relation],
 )
 @inject