From 4226caa60a7b4879de79413d267f91c9a9ee1c13 Mon Sep 17 00:00:00 2001 From: Vasek Sraier Date: Sun, 24 Mar 2019 11:23:35 +0100 Subject: [PATCH] improved README --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index fea7ec3..0861ace 100644 --- a/README.md +++ b/README.md @@ -20,3 +20,11 @@ pipenv run python register.py --help ``` Zbytek by měl být samovysvětlující. Stačí vyměnit argumenty dle nápovědy z `--help`. + + +## Dokumentace API Gitei + +Gitea má specifikaci API popsanou dle specifikace OpenAPI 2.0 (dříve nazýváno Swagger). Pokud není explicitně řečeno +jinak, je tato specifikace vystavena na každé běžící instanci a to na cestě `/api/swagger`. Přesněji, na této cestě je +standardní vygenerovaný webový interface ke specifikaci. Specifikace samotná se nachází (alespoň v době psaní) na cestě +`/swagger.v1.json`. \ No newline at end of file