mirror of
https://github.com/peeringdb/peeringdb.git
synced 2024-05-11 05:55:09 +00:00
5147028bee
* stub in poetry for pipenv * re-add tester image * add pre-commit / formatting * fix ghactions * revert test data whitespace, exclude tests/data * revert ws * decruft, rm tox/pipenv * install dev packages for base image * add lgtm config to force to py3
646 B
646 B
Contributing to the API documentation
The openapi schema that is used to render the API documentation is generated automatically. However it
is possible for the community to contribute to and augment the documentation by editing the files
located in this (/docs/api/) directory.
The contents of these files are joined into the various openapi description fields when the schema file is regenerated.
Note that changes to these files won't show up in the documentation until the openapi schema file is regenerated and redeployed.
Regenerating the schema
python manage.py generateschema > peeringdb_server/static/api-schema.yaml