mirror of
https://github.com/inventree/InvenTree.git
synced 2025-08-06 20:11:37 +00:00
39ba25c5ed
* Render API docs
* Cleanup broken links
* Re-enable strict mode
* Change json to yaml
* Update docs/docs/api/schema.md
Co-authored-by: Matthias Mair <code@mjmair.com>
* Update docs/docs/api/schema.md
Co-authored-by: Matthias Mair <code@mjmair.com>
* Use neoteroi-mkdocs instead
- seems to render more reliably
* Fix SERVERS section for SPECTACTULAR_SETTINGS
* Script for splitting schema into smaller sections
* Generate an index file for the schema pages
* Move schema.md up one directory
* Fix formatting
* Remove tracked file
* Add hook for rebuilding API schema as part of RTD build
* Extract schema as RTD build step
* install invoke
* export env vars
* remove argparse
* Fix order of operations
* Compress env vars
* Remove custom env vars
- Now configured as part of RTD project
* Migrate db
* Revert "remove argparse"
This reverts commit 4665805340.
* Post-process generated schema file
* Fix file formatting
* Add note about schema repo
* no message
* Reduce schema overhead
* Ignore generated files
* Delete generated file
* Update .gitignore
* Add extra split for machine integration
* Remove schema files
- These will be auto-generated too
* Generate individual schema .md files
* Re-add .md files
- Need git commit log to work
* Update .gitignore
* Fix for CI test
* patch machine.api
* Revert previous change
* Formatting fix
* Adjust export step
* Bump API version
---------
Co-authored-by: Matthias Mair <code@mjmair.com>
1.9 KiB
1.9 KiB
title
| title |
|---|
| InvenTree API Schema |
The InvenTree API is implemented using the Django REST framework. The API schema as documented below is generated using the drf-spectactular extension.
API Version
This documentation is for API version: 171
!!! tip "API Schema History" We track API schema changes, and provide a snapshot of each API schema version in the API schema repository.
API Schema File
The API schema file is available for download, and can be used for generating client libraries, or for testing API endpoints.
API Schema Documentation
API schema documentation is split into the following categories:
| Category | Description |
|---|---|
| Authorization and Authentication | Authorization and Authentication |
| Background Task Management | Background Task Management |
| Barcode Scanning | Barcode Scanning |
| Bill of Materials | Bill of Materials |
| Build Order Management | Build Order Management |
| Company Management | Company Management |
| Label Printing | Label Printing |
| External Machine Management | External Machine Management |
| External Order Management | External Order Management |
| Parts and Part Categories | Parts and Part Categories |
| Plugin Functionality | Plugin Functionality |
| Report Generation | Report Generation |
| Settings Management | Settings Management |
| Stock and Stock Locations | Stock and Stock Locations |
| User Management | User Management |
| General | General API endpoints |