diff options
| author |   Georg Kunz <georg.kunz@ericsson.com> | 2018-05-02 22:44:00 +0200 |
|---|---|---|
| committer | Georg Kunz <georg.kunz@ericsson.com> | 2018-05-11 02:43:43 +0200 |
| commit | 8048568b27c8b6fb5a5a269c66f722bceb4b338d (patch) | |
| tree | 6a54b93108eb3d5a3d92fe4aca4181cba693bb74 /docs/testing/user/ovpaddendum | |
| parent | 962f8ed21b97d40bc501c4854a4e28310023642d (diff) | |
Adding documentation for API validation exemption
Updating the user guide and OVP addendum to include references to the
detailed document describing the API response validation exemption.
JIRA: DOVETAIL-651
Change-Id: I4026f84f021704f0986b45680471e8fb711fc314
Signed-off-by: Georg Kunz <georg.kunz@ericsson.com>
Diffstat (limited to 'docs/testing/user/ovpaddendum')
| -rw-r--r-- | docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst | 10 | ||||
| -rw-r--r-- | docs/testing/user/ovpaddendum/index.rst | 12 |
2 files changed, 18 insertions, 4 deletions
diff --git a/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst b/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst index 3acc6ee8..58b9283f 100644 --- a/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst +++ b/docs/testing/user/ovpaddendum/exemption-strict-API-validation.rst @@ -3,9 +3,11 @@ .. http://creativecommons.org/licenses/by/4.0 .. (c) Ericsson and others -============================================================== -Exemption Process - Disabling Strict API Validation in Tempest -============================================================== +.. _dovetail-exemption_process_api_response_validation: + +========================================== +Disabling Strict API Validation in Tempest +========================================== .. toctree:: :maxdepth: 2 @@ -136,7 +138,7 @@ Exemption process for additional properties in API responses in the OVP The details of the exemption process for disabling strict validation of API responses is as follows: -#. The Dovetail tool provides a new command line option "--non-strict-api" for +#. The Dovetail tool provides a new command line option "--no-api-validation" for disabling strict API validation. This option needs to be explicitly given on the command line to disable strict API validation. If this command line option is omitted, the default behavior (i.e., strict API validation) is diff --git a/docs/testing/user/ovpaddendum/index.rst b/docs/testing/user/ovpaddendum/index.rst index a78d1997..054a3f11 100644 --- a/docs/testing/user/ovpaddendum/index.rst +++ b/docs/testing/user/ovpaddendum/index.rst @@ -414,6 +414,18 @@ documented and accepted by the reviewers. Applicants who choose to run the optional test cases can include the results of the optional test cases to highlight the additional compliance. + +Exemption from strict API response validation +============================================= + +Vendors of commercial NFVI products may have extended the Nova API to support +proprietary add-on features. These additions can cause Nova Tempest API tests +to fail due to unexpected data in API responses. In order to resolve this +transparently in the context of OVP, a temporary exemption process has been +created. More information on the exemption can be found in section +:ref:`dovetail-exemption_process_api_response_validation`. + + .. References .. _`OVP Governance Guidelines`: https://www.opnfv.org/wp-content/uploads/sites/12/2018/01/OVP-Governance-Guidelines-1.0.1-012218.pdf .. _`Pharos specification`: https://wiki.opnfv.org/display/pharos/Pharos+Specification |