summaryrefslogtreecommitdiff
path: root/doc/reference
diff options
context:
space:
mode:
authorOlivier Laurent <olt@odoo.com>2015-09-14 10:35:52 +0200
committerOlivier Laurent <olt@odoo.com>2015-09-14 11:52:12 +0200
commit47133c7d3f31db70e569213ab4265b876384f8e0 (patch)
tree0424fa189fb292cb02c153afcee1e601aa84a8a0 /doc/reference
parent5ac77c943be674ef912bb6a5e6d86b677392c238 (diff)
[ADD] doc: database upgrade API: structure change
1° add a second level of titles because they were too long and overrided the second column (the 'code column) 2° Add 'double backticks' around some keys
Diffstat (limited to 'doc/reference')
-rw-r--r--doc/reference/upgrade_api.rst34
1 files changed, 19 insertions, 15 deletions
diff --git a/doc/reference/upgrade_api.rst b/doc/reference/upgrade_api.rst
index 1e437707857..0581e2bf614 100644
--- a/doc/reference/upgrade_api.rst
+++ b/doc/reference/upgrade_api.rst
@@ -10,11 +10,14 @@
Upgrade API
===========
+Introduction
+~~~~~~~~~~~~
+
This document describes the API used to upgrade an Odoo database to a
higher version.
It allows a database to be upgraded without ressorting to the html form at
-https://upgrade.odoo.com/database/upload
+https://upgrade.odoo.com
Although the database will follow the same process described on that form.
@@ -26,6 +29,9 @@ The required steps are:
* obtaining the status of the database request
* downloading the upgraded database dump
+The methods
+~~~~~~~~~~~
+
.. _upgrade-api-create-method:
Creating a database upgrade request
@@ -40,8 +46,8 @@ This action creates a database request with the following information:
* the database dump name (required but purely informative)
* optionally the server timezone (for Odoo source version < 6.1)
-create method
--------------
+The ``create`` method
+---------------------
.. py:function:: https://upgrade.odoo.com/database/v1/create
@@ -56,11 +62,10 @@ create method
:return: request result
:rtype: json dictionary
-
The *create* method returns a json dictionary containing the following keys:
-failures
-''''''''
+``failures``
+''''''''''''
The list of errors.
@@ -107,8 +112,8 @@ See a sample output aside.
}
-request
-'''''''
+``request``
+'''''''''''
If the *create* method is successful, the value associated to the *request* key
will be a dictionary containing various information about the created request:
@@ -198,8 +203,8 @@ Uploading your database dump
This action upload your database dump.
-upload method
--------------
+The ``upload`` method
+---------------------
.. py:function:: https://upgrade.odoo.com/database/v1/upload
@@ -269,8 +274,8 @@ Asking to process your request
This action ask the Upgrade Platform to process your database dump.
-process method
---------------
+The ``process`` method
+----------------------
.. py:function:: https://upgrade.odoo.com/database/v1/process
@@ -335,8 +340,8 @@ Obtaining your request status
This action ask the status of your database upgrade request.
-status method
--------------
+The ``status`` method
+---------------------
.. py:function:: https://upgrade.odoo.com/database/v1/status
@@ -392,7 +397,6 @@ database upgrade request.
URL_PARAMS="key=${KEY}&request=${REQUEST_ID}"
curl -sS "${PROCESS_URL}?${URL_PARAMS}"
-
Sample output
-------------