improved README

This commit is contained in:
Vašek Šraier 2019-03-24 11:23:35 +01:00
parent db03d3eb88
commit 4226caa60a

View file

@ -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`.