From 250286e335f7f4a04117d95a8f26c5a99e66d328 Mon Sep 17 00:00:00 2001 From: Christoph Wurst Date: Fri, 30 Sep 2022 16:22:18 +0200 Subject: [PATCH] Document maintenance mode header Signed-off-by: Christoph Wurst --- developer_manual/client_apis/general.rst | 15 +++++++++++++++ developer_manual/client_apis/index.rst | 1 + developer_manual/digging_deeper/rest_apis.rst | 2 ++ 3 files changed, 18 insertions(+) create mode 100644 developer_manual/client_apis/general.rst diff --git a/developer_manual/client_apis/general.rst b/developer_manual/client_apis/general.rst new file mode 100644 index 000000000..84148b904 --- /dev/null +++ b/developer_manual/client_apis/general.rst @@ -0,0 +1,15 @@ +======= +General +======= + +Nextcloud's APIs are mainly available through :ref:`rest-apis`, :ref:`OCS ` and :ref:`webdavapiindex`. + +Generic Errors +-------------- + +Additional to specific errors of an API, there are a few generic errors Nextcloud might throw on web APIs. + +Maintenance Mode +**************** + +If Nextcloud is down for maintenance, it sends a HTTP response with status code 503 and the header ``x-nextcloud-maintenance-mode: 1``. diff --git a/developer_manual/client_apis/index.rst b/developer_manual/client_apis/index.rst index f5f6fc0c8..f7a8761f9 100644 --- a/developer_manual/client_apis/index.rst +++ b/developer_manual/client_apis/index.rst @@ -7,6 +7,7 @@ Clients and Client APIs .. toctree:: :maxdepth: 2 + general android_library/index WebDAV/index OCS/index diff --git a/developer_manual/digging_deeper/rest_apis.rst b/developer_manual/digging_deeper/rest_apis.rst index caae8c1f3..c85f331bd 100644 --- a/developer_manual/digging_deeper/rest_apis.rst +++ b/developer_manual/digging_deeper/rest_apis.rst @@ -1,3 +1,5 @@ +.. _rest-apis: + ========= REST APIs =========