Minor changes

Author: Alex Carrega

docs/parameters.rst

@@ -11,17 +11,17 @@ Management of the parameters included in configuration files.
 Parameters Settings Model
 -------------------------
 
-+-------------+-------------------+-------------------------------------------------------------------+----------------------+----------+
-| Field       | Type              | Description                                                       | Example              | Required |
-+-------------+-------------------+-------------------------------------------------------------------+----------------------+----------+
-| ``source``  | String            | Path of the configuration file that includes the parameter.       | /opt/test.json       | True     |
-+-------------+-------------------+-------------------------------------------------------------------+----------------------+----------+
-| ``format``  | Enum(json,yaml)   | Format of the configuration file where the parameter is included. | yaml                 | True     |
-+-------------+-------------------+-------------------------------------------------------------------+----------------------+----------+
-| ``xpath``   | List(String)      | List of keys to indicate the xpath in the configuration file.     | ('agent', 'enabled') | True     |
-+-------------+-------------------+-------------------------------------------------------------------+----------------------+----------+
-| ``history`` | List(ActionModel) | History of parameter updates.                                     |                      | True     |
-+-------------+-------------------+-------------------------------------------------------------------+----------------------+----------+
++-------------+-------------------------+-------------------------------------------------------------------+----------------------+----------+
+| Field       | Type                    | Description                                                       | Example              | Required |
++-------------+-------------------------+-------------------------------------------------------------------+----------------------+----------+
+| ``source``  | String                  | Path of the configuration file that includes the parameter.       | /opt/test.json       | True     |
++-------------+-------------------------+-------------------------------------------------------------------+----------------------+----------+
+| ``format``  | Enum(String)[json,yaml] | Format of the configuration file where the parameter is included. | yaml                 | True     |
++-------------+-------------------------+-------------------------------------------------------------------+----------------------+----------+
+| ``xpath``   | List(String)            | List of keys to indicate the xpath in the configuration file.     | ('agent', 'enabled') | True     |
++-------------+-------------------------+-------------------------------------------------------------------+----------------------+----------+
+| ``history`` | List(ActionModel)       | History of parameter updates.                                     |                      | True     |
++-------------+-------------------------+-------------------------------------------------------------------+----------------------+----------+
 
 
 .. _parameters-output-model:

docs/settings.rst

@@ -7,26 +7,29 @@ The settings of `RESTable` are set in the file `settings.yaml'.
 
 The schema of this file is the following:
 
-+--------------------+------------------------------------------------------------------+----------------------------+-----------------------------------+----------+------+
-| Field              | Type                                                             | Description                | Example                           | Required |      |
-+====================+==================================================================+============================+===================================+==========+======+
-| ``port``           | Integer                                                          | Port where the             | interface is waiting for request. | 9999     | True |
-+--------------------+------------------------------------------------------------------+----------------------------+-----------------------------------+----------+------+
-| ``debug``          | Boolean                                                          | Activates the debug.       | True                              | False    |      |
-+--------------------+------------------------------------------------------------------+----------------------------+-----------------------------------+----------+------+
-| ``project``        | String                                                           | Project name               | GUARD                             | True     |      |
-+--------------------+------------------------------------------------------------------+----------------------------+-----------------------------------+----------+------+
-| ``title``          | String                                                           | Title of the service.      | RESTable Test                     | True     |      |
-+--------------------+------------------------------------------------------------------+----------------------------+-----------------------------------+----------+------+
-| ``description``    | String                                                           | Description of the service |                                   | True     |      |
-+--------------------+------------------------------------------------------------------+----------------------------+-----------------------------------+----------+------+
-| ``commands``       | Dictionary(Command ID, :ref:`command-settings-mode`)             | Available commands         |                                   | False    |      |
-+--------------------+------------------------------------------------------------------+----------------------------+-----------------------------------+----------+------+
-| ``configurations`` | Dictionary(Configuration ID, :ref:`configuration-settings-mode`) | Available configurations   |                                   | False    |      |
-+--------------------+------------------------------------------------------------------+----------------------------+-----------------------------------+----------+------+
-| ``parameters``     | Dictionary(Parameter ID, :ref:`parameter-settings-mode`)         | Available parameters       |                                   | False    |      |
-+--------------------+------------------------------------------------------------------+----------------------------+-----------------------------------+----------+------+
++--------------------+-----------------+----------------------------+-----------------------------------+----------+------+
+| Field              | Type            | Description                | Example                           | Required |      |
++====================+=================+============================+===================================+==========+======+
+| ``port``           | Integer         | Port where the             | interface is waiting for request. | 9999     | True |
++--------------------+-----------------+----------------------------+-----------------------------------+----------+------+
+| ``debug``          | Boolean         | Activates the debug.       | True                              | False    |      |
++--------------------+-----------------+----------------------------+-----------------------------------+----------+------+
+| ``project``        | String          | Project name               | GUARD                             | True     |      |
++--------------------+-----------------+----------------------------+-----------------------------------+----------+------+
+| ``title``          | String          | Title of the service.      | RESTable Test                     | True     |      |
++--------------------+-----------------+----------------------------+-----------------------------------+----------+------+
+| ``description``    | String          | Description of the service |                                   | True     |      |
++--------------------+-----------------+----------------------------+-----------------------------------+----------+------+
+| ``commands``       | Dictionary [1]_ | Available commands         |                                   | False    |      |
++--------------------+-----------------+----------------------------+-----------------------------------+----------+------+
+| ``configurations`` | Dictionary [2]_ | Available configurations   |                                   | False    |      |
++--------------------+-----------------+----------------------------+-----------------------------------+----------+------+
+| ``parameters``     | Dictionary [3]_ | Available parameters       |                                   | False    |      |
++--------------------+-----------------+----------------------------+-----------------------------------+----------+------+
 
+.. [1] Key: command ID, value: :ref:`commands-settings-model`.
+.. [2] Key: configuration ID, value: :ref:`configurations-settings-model`.
+.. [3] Key: parameter ID, value: :ref:`parameters-settings-model`.
 
 .. |REST| replace:: :abbr:`REST (Representational State Transfer)`
 .. |TCP| replace:: :abbr:`TCP (Transmission Control Protocol)`