mirror of
https://github.com/inventree/InvenTree
synced 2024-08-30 18:33:04 +00:00
Render API docs
This commit is contained in:
parent
9c93130224
commit
6dedc0f22e
33261
docs/docs/api/api.json
Normal file
33261
docs/docs/api/api.json
Normal file
File diff suppressed because it is too large
Load Diff
9
docs/docs/api/schema.md
Normal file
9
docs/docs/api/schema.md
Normal file
@ -0,0 +1,9 @@
|
||||
---
|
||||
title: 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/) extensions.
|
||||
|
||||
## Schama
|
||||
|
||||
!!swagger api.json!!
|
@ -182,6 +182,7 @@ nav:
|
||||
- Extend:
|
||||
- InvenTree API:
|
||||
- Overview: api/api.md
|
||||
- Schema: api/schema.md
|
||||
- Model Metadata: api/metadata.md
|
||||
- Download Data: api/download.md
|
||||
- Bulk Delete: api/bulk_delete.md
|
||||
@ -222,6 +223,7 @@ nav:
|
||||
|
||||
# Plugins
|
||||
plugins:
|
||||
- render_swagger
|
||||
- include-markdown:
|
||||
opening_tag: "{!"
|
||||
closing_tag: "!}"
|
||||
@ -281,4 +283,4 @@ extra:
|
||||
link: https://reddit.com/r/inventree
|
||||
|
||||
use_directory_urls: true
|
||||
strict: true
|
||||
strict: false
|
||||
|
@ -4,3 +4,4 @@ mkdocs-material>=9.0,<10.0
|
||||
mkdocs-git-revision-date-localized-plugin>=1.1,<2.0
|
||||
mkdocs-simple-hooks>=0.1,<1.0
|
||||
mkdocs-include-markdown-plugin
|
||||
mkdocs-render-swagger-plugin
|
||||
|
Loading…
Reference in New Issue
Block a user