diff --git a/docs/api.md b/docs/api.md index 82d9a71b6..aecfbafe9 100644 --- a/docs/api.md +++ b/docs/api.md @@ -2,7 +2,7 @@ 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 -`/api/api/schema/swagger-ui/`. +`/api/api/schema/view/`. 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 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 process was started successfully, with the UUID of the consumption task as the data. No additional status information about the consumption process diff --git a/src/paperless/settings.py b/src/paperless/settings.py index a0f006464..3e7e18e3e 100644 --- a/src/paperless/settings.py +++ b/src/paperless/settings.py @@ -353,7 +353,7 @@ REST_FRAMEWORK = { # DRF Spectacular settings SPECTACULAR_SETTINGS = { - "TITLE": "Paperless-ngx API", + "TITLE": "Paperless-ngx REST API", "DESCRIPTION": "OpenAPI Spec for Paperless-ngx", "VERSION": "6.0.0", "SERVE_INCLUDE_SCHEMA": False, diff --git a/src/paperless/urls.py b/src/paperless/urls.py index f831bafc7..24bc120b7 100644 --- a/src/paperless/urls.py +++ b/src/paperless/urls.py @@ -215,7 +215,7 @@ urlpatterns = [ name="schema", ), re_path( - "^swagger-ui/", + "^view/", SpectacularSwaggerView.as_view(), name="swagger-ui", ),