InvenTree/InvenTree/common
Oliver af4d888b1b
Generate API docs (#6319)
* Add basic task for generating apidocs

* Fix SPECTACTULAR_SETTINGS

- Some provided options were not correct

* Update .gitignore

* Fix for duplicated API path

- `/api/plugins/activate` routed to PluginActivate view
- Must be associated with a specific plugin ID

* By default, fail if warnings are raised

* Use GenericAPIView for GetAuthToken

* Use GenericAPIView for RolesDetail endpoint

* Refactor more endpoints to use GenericApiView

* More API cleanup

* Add extra type hints for exposed methods

* Update RoleDetails endpoint

- Specify serializer
- Use RetrieveAPI class type

* More type hints

* Export API docs as part of CI

* add more api views docs

* even more docs

* extend tests to api-version

* simplify serializer

* and more docs

* fix serializer

* added more API docs

* clean diff

* Added APISearch base

* do not assume you know the user
he might be anonymously creating the schema ;-)

* set empty serializer where no input is needed

* Use dummy model for schema generation

* fix OpenAPI docs section

* Update .github/workflows/qc_checks.yaml

Co-authored-by: Matthias Mair <code@mjmair.com>

* REmove duplicate commands

* Ignore warnings in CI

---------

Co-authored-by: Matthias Mair <code@mjmair.com>
2024-02-08 16:19:57 +11:00
..
fixtures fix endline 2022-05-20 13:35:07 +02:00
migrations Project Responsible (#5944) 2023-11-21 23:13:20 +11:00
__init__.py startapp common 2019-09-03 08:30:14 +10:00
admin.py [CI] Enable python autoformat (#6169) 2024-01-11 11:28:58 +11:00
api.py Generate API docs (#6319) 2024-02-08 16:19:57 +11:00
apps.py [CI] docstrings (#6172) 2024-01-11 14:40:07 +11:00
files.py [CI] Enable python autoformat (#6169) 2024-01-11 11:28:58 +11:00
forms.py [CI] Enable python autoformat (#6169) 2024-01-11 11:28:58 +11:00
models.py Generate API docs (#6319) 2024-02-08 16:19:57 +11:00
notifications.py Handle null case for delivery_methods (#6411) 2024-02-05 21:24:59 +11:00
serializers.py Generate API docs (#6319) 2024-02-08 16:19:57 +11:00
settings.py [CI] docstrings (#6172) 2024-01-11 14:40:07 +11:00
tasks.py Fix news feed task timeout (#6250) 2024-01-17 17:52:52 +11:00
test_notifications.py [CI] Enable python autoformat (#6169) 2024-01-11 11:28:58 +11:00
test_tasks.py Fix news feed task timeout (#6250) 2024-01-17 17:52:52 +11:00
test_views.py Docstring checks in QC checks (#3089) 2022-06-02 01:37:39 +10:00
tests.py Reimplement error-report API endpoint (#6317) 2024-01-22 12:03:58 +00:00
urls.py [CI] Enable python autoformat (#6169) 2024-01-11 11:28:58 +11:00
views.py [CI] Enable python autoformat (#6169) 2024-01-11 11:28:58 +11:00