Mirrored_Repos/InvenTree
1
0
Fork 0
mirror of https://github.com/inventree/InvenTree synced 2024-08-30 18:33:04 +00:00
Code Issues Packages Projects Releases Wiki Activity

Fix formatting

Browse Source
This commit is contained in:
Oliver Walters 2024-02-12 20:43:14 +11:00
parent 5ab798d53d
commit 6ba4aaff7f
2 changed files with 17 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

29
docs/docs/api/schema.md
View File

@ -1,26 +1,25 @@
---
title: InvenTree API Schema
---
--- The InvenTree API is implemented using the [Django REST framework](https://www.django-rest-framework.org).
title: InvenTree API Schema The API schema as documented below is generated using the [drf-spectactular](https://github.com/tfranzel/drf-spectacular/) extension.
---
The InvenTree API is implemented using the [Django REST framework](https://www.django-rest-framework.org). ## API Version
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: `166`
This documentation is for API version: `166` ## API Schema File
## API Schema File The API schema file is available for download, and can be used for generating client libraries, or for testing API endpoints.
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 API schema documentation is split into the following categories:
API schema documentation is split into the following categories: | Category | Description |
| --- | --- |
| Category | Description | | [Authorization and Authentication](./schema/auth.md) | Authorization and Authentication |
| --- | --- |
| [Authorization and Authentication](./schema/auth.md) | Authorization and Authentication |
| [Background Task Management](./schema/background-task.md) | Background Task Management | | [Background Task Management](./schema/background-task.md) | Background Task Management |
| [Barcode Scanning](./schema/barcode.md) | Barcode Scanning | | [Barcode Scanning](./schema/barcode.md) | Barcode Scanning |
| [Bill of Materials](./schema/bom.md) | Bill of Materials | | [Bill of Materials](./schema/bom.md) | Bill of Materials |

3
docs/exctract_schema.py
View File

@ -2,6 +2,7 @@
import argparse import argparse
import os import os
import textwrap
import yaml import yaml
@ -75,6 +76,8 @@ def generate_index_file(version: str):
| --- | --- | | --- | --- |
""" """
output = textwrap.dedent(output).strip() + '\n'
for key, value in SPECIAL_PATHS.items(): for key, value in SPECIAL_PATHS.items():
output += f'| [{value}](./schema/{key}.md) | {value} |\n' output += f'| [{value}](./schema/{key}.md) | {value} |\n'