mirror of
https://github.com/inventree/InvenTree.git
synced 2025-08-09 13:20:53 +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>
41 lines
1.9 KiB
Markdown
41 lines
1.9 KiB
Markdown
---
|
|
title: InvenTree API Schema
|
|
---
|
|
|
|
The InvenTree API is implemented using the [Django REST framework](https://www.django-rest-framework.org).
|
|
The API schema as documented below is generated using the [drf-spectactular](https://github.com/tfranzel/drf-spectacular/) 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](https://github.com/inventree/schema/).
|
|
|
|
## 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](./schema/auth.md) | Authorization and Authentication |
|
|
| [Background Task Management](./schema/background-task.md) | Background Task Management |
|
|
| [Barcode Scanning](./schema/barcode.md) | Barcode Scanning |
|
|
| [Bill of Materials](./schema/bom.md) | Bill of Materials |
|
|
| [Build Order Management](./schema/build.md) | Build Order Management |
|
|
| [Company Management](./schema/company.md) | Company Management |
|
|
| [Label Printing](./schema/label.md) | Label Printing |
|
|
| [External Machine Management](./schema/machine.md) | External Machine Management |
|
|
| [External Order Management](./schema/order.md) | External Order Management |
|
|
| [Parts and Part Categories](./schema/part.md) | Parts and Part Categories |
|
|
| [Plugin Functionality](./schema/plugins.md) | Plugin Functionality |
|
|
| [Report Generation](./schema/report.md) | Report Generation |
|
|
| [Settings Management](./schema/settings.md) | Settings Management |
|
|
| [Stock and Stock Locations](./schema/stock.md) | Stock and Stock Locations |
|
|
| [User Management](./schema/user.md) | User Management |
|
|
| [General](./schema/general.md) | General API endpoints |
|