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