mirror of
https://github.com/inventree/InvenTree.git
synced 2025-11-14 11:56:44 +00:00
[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
This commit is contained in:
@@ -16,22 +16,16 @@ If the server is running in [Debug Mode](../start/index.md#debug-mode) then an i
|
||||
|
||||
Various list endpoints can be displayed as shown below:
|
||||
|
||||
{% with id="api_browse", url="api/api_browse.png", description="List API" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
{{ image("api/api_browse.png", "List API") }}
|
||||
|
||||
### Filtering
|
||||
|
||||
List views can be filtered interactively:
|
||||
|
||||
{% with id="api_filter", url="api/api_filters.png", description="Filter API" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
{{ image("api/api_filters.png", "Filter API") }}
|
||||
|
||||
### Detail View
|
||||
|
||||
Detail view endpoints can also be displayed:
|
||||
|
||||
{% with id="api_detail", url="api/api_detail.png", description="Detail API" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
{{ image("api/api_detail.png", "Detail API") }}
|
||||
|
||||
@@ -13,9 +13,7 @@ InvenTree provides a powerful REST API for interacting with inventory data on th
|
||||
|
||||
The API is self-documenting, and the documentation is provided alongside any InvenTree installation instance. If (for example) you have an InvenTree instance running at `http://127.0.0.1:8000` then the API documentation is available at `http://127.0.0.1:8000/api-doc/`
|
||||
|
||||
{% with id="api_doc", url="api/api_doc.png", description="API documentation" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
{{ image("api/api_doc.png", "API documentation") }}
|
||||
|
||||
### Browseble API
|
||||
|
||||
@@ -152,15 +150,11 @@ Once a user has *authenticated* via the API, a list of the available roles can b
|
||||
|
||||
For example, when accessing the API from a *superuser* account:
|
||||
|
||||
{% with id="api_roles", url="api/api_roles.png", description="API superuser roles" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
{{ image("api/api_roles.png", "API superuser roles") }}
|
||||
|
||||
Or, when accessing the API from an account which has read-only permissions:
|
||||
|
||||
{% with id="api_roles_2", url="api/api_roles_2.png", description="API user roles" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
{{ image("api/api_roles_2.png", "API user roles") }}
|
||||
|
||||
### Permission Denied
|
||||
|
||||
|
||||
@@ -15,9 +15,7 @@ To request metadata about a particular API endpoint, simply perform an `OPTIONS`
|
||||
|
||||
For example, to view the metadata available for creating a new [Part Category](../part/index.md#part-category), an `OPTIONS` request to `/api/part/category/` yields:
|
||||
|
||||
{% with id="api_cat_options", url="api/api_category_options.png", description="Part category options" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
{{ image("api/api_category_options.png", "Part category options") }}
|
||||
|
||||
You can see here a detailed list of the various fields which are available for this API endpoint.
|
||||
|
||||
@@ -33,9 +31,7 @@ The `OPTIONS` endpoint provides the following information:
|
||||
|
||||
Specific details are provided on the available attributes of each field:
|
||||
|
||||
{% with id="api_fields", url="api/api_metadata_fields.png", description="Metadata fields" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
{{ image("api/api_metadata_fields.png", "Metadata fields") }}
|
||||
|
||||
### Field Types
|
||||
|
||||
@@ -82,10 +78,5 @@ Field *label* and *help text* values are localized using the [community contribu
|
||||
|
||||
For example, the same forms (in the web interface) are served via identical API requests, with the locale information determined "on the fly":
|
||||
|
||||
{% with id="api_english", url="api/api_english.png", description="API forms (english)" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
|
||||
{% with id="api_german", url="api/api_german.png", description="API forms (german)" %}
|
||||
{% include 'img.html' %}
|
||||
{% endwith %}
|
||||
{{ image("api/api_english.png", "API forms (english)") }}
|
||||
{{ image("api/api_german.png", "API forms (german)") }}
|
||||
|
||||
Reference in New Issue
Block a user