Files
InvenTree/docs/docs/api/browse.md
T
OliverandGitHub 11ab0203b1 [plugin] Auto issue orders (#9565)
* Add builtin plugin for auto-issuing orders

* Add plugin to auto-issue orders

* Add placeholder documentation

* Fix typo

* Adds image macro

- To replace img.html
- includes checking if file exists

* Fix tooltips

* More docs

* Adjust plugin settings filters

* docs

* More docs

* More docs

* Updates

* Less restrictive URL checking

* Refactor build order page

* Fix typo

* Allow 429

* Debug output

* More debug

* Construct assets dir

* Cleanup

* Update docs README

* Refactoring more pages

* Fix image link

* Fix SSO settings

* Add hook to check for missing settings

- Ensure that all settings are documented!

* Add missing user settings

* Update docstring

* Tweak SSO.md

* Image updates

* More updates

* Tweaks

* Exclude orders without a target_date

* Fix for issuing build orders

* Further refactoring

* Fixes

* Image refactoring

* More refactoring

* More refactoring

* Refactor app images

* Fix pathing issues

* Suppress some openapidocs warnings in logs

(much easier to debug docs build issues)

* Fix image reference

* Reduce error messages

* Fix image links

* Fix image links

* Reduce docs log output

* Ensure settings are loaded before displaying them

* Fix for UI test

* Fix unit test

* Test tweaks
2025-06-03 17:07:12 +10:00

803 B

title
title
Interactive API

Interactive API

If the server is running in Debug Mode then an interactive version of the API is available using a browser.

!!! info "Debug Mode" This interactive API is only available when running the server in debug mode

!!! warning "Slow Traffic Ahead" The interactive API is significantly slower than using the normal JSON format. It is provided only for development and testing.

List View

Various list endpoints can be displayed as shown below:

{{ image("api/api_browse.png", "List API") }}

Filtering

List views can be filtered interactively:

{{ image("api/api_filters.png", "Filter API") }}

Detail View

Detail view endpoints can also be displayed:

{{ image("api/api_detail.png", "Detail API") }}