Skip to content

Commit

Permalink
[ADD] doc: database upgrade API: structure change
Browse files Browse the repository at this point in the history
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
  • Loading branch information
Olivier Laurent committed Sep 14, 2015
1 parent 5ac77c9 commit 47133c7
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions doc/reference/upgrade_api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.


Expand All @@ -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
Expand All @@ -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
Expand All @@ -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.

Expand Down Expand Up @@ -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:
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -392,7 +397,6 @@ database upgrade request.
URL_PARAMS="key=${KEY}&request=${REQUEST_ID}"
curl -sS "${PROCESS_URL}?${URL_PARAMS}"
Sample output
-------------

Expand Down

0 comments on commit 47133c7

Please sign in to comment.