mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-06-22 15:27:28 -05:00
Some settings
This commit is contained in:
parent
fdf6eb1b75
commit
38f44469f1
@ -2,7 +2,7 @@
|
|||||||
|
|
||||||
Paperless-ngx now ships with a fully-documented REST API and a browsable
|
Paperless-ngx now ships with a fully-documented REST API and a browsable
|
||||||
web interface to explore it. The API browsable interface is available at
|
web interface to explore it. The API browsable interface is available at
|
||||||
`/api/api/schema/swagger-ui/`.
|
`/api/api/schema/view/`.
|
||||||
|
|
||||||
Further documentation is provided here for some endpoints and features.
|
Further documentation is provided here for some endpoints and features.
|
||||||
|
|
||||||
@ -195,10 +195,6 @@ The endpoint supports the following optional form fields:
|
|||||||
- `custom_fields`: An array of custom field ids to assign (with an empty
|
- `custom_fields`: An array of custom field ids to assign (with an empty
|
||||||
value) to the document.
|
value) to the document.
|
||||||
|
|
||||||
!!! note
|
|
||||||
|
|
||||||
Sending a `Content-Length` header with correct size is mandatory.
|
|
||||||
|
|
||||||
The endpoint will immediately return HTTP 200 if the document consumption
|
The endpoint will immediately return HTTP 200 if the document consumption
|
||||||
process was started successfully, with the UUID of the consumption task
|
process was started successfully, with the UUID of the consumption task
|
||||||
as the data. No additional status information about the consumption process
|
as the data. No additional status information about the consumption process
|
||||||
|
@ -353,7 +353,7 @@ REST_FRAMEWORK = {
|
|||||||
|
|
||||||
# DRF Spectacular settings
|
# DRF Spectacular settings
|
||||||
SPECTACULAR_SETTINGS = {
|
SPECTACULAR_SETTINGS = {
|
||||||
"TITLE": "Paperless-ngx API",
|
"TITLE": "Paperless-ngx REST API",
|
||||||
"DESCRIPTION": "OpenAPI Spec for Paperless-ngx",
|
"DESCRIPTION": "OpenAPI Spec for Paperless-ngx",
|
||||||
"VERSION": "6.0.0",
|
"VERSION": "6.0.0",
|
||||||
"SERVE_INCLUDE_SCHEMA": False,
|
"SERVE_INCLUDE_SCHEMA": False,
|
||||||
|
@ -215,7 +215,7 @@ urlpatterns = [
|
|||||||
name="schema",
|
name="schema",
|
||||||
),
|
),
|
||||||
re_path(
|
re_path(
|
||||||
"^swagger-ui/",
|
"^view/",
|
||||||
SpectacularSwaggerView.as_view(),
|
SpectacularSwaggerView.as_view(),
|
||||||
name="swagger-ui",
|
name="swagger-ui",
|
||||||
),
|
),
|
||||||
|
Loading…
x
Reference in New Issue
Block a user