centersl/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-03-27 13:38:39 +07:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #9189 from nextcloud/enhancement/dev-docs-maintenance-mdoe

Browse Source 
Document maintenance mode header
This commit is contained in:
Christoph Wurst
2022-09-30 16:43:29 +02:00
committed by GitHub
parent 8326cf14da 250286e335
commit b7a4d31e39
3 changed files with 18 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
developer_manual/client_apis/general.rst Normal file
View File

@@ -0,0 +1,15 @@
=======
General
=======
Nextcloud's APIs are mainly available through :ref:`rest-apis`, :ref:`OCS <ocsapiindex>` 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``.

1
developer_manual/client_apis/index.rst
View File

@@ -7,6 +7,7 @@ Clients and Client APIs
.. toctree::
:maxdepth: 2
general
android_library/index
WebDAV/index
OCS/index

2
developer_manual/digging_deeper/rest_apis.rst
View File

@@ -1,3 +1,5 @@
.. _rest-apis:
=========
REST APIs
=========