blob: e97968385e4ba2fa5df2623e7d6e9c438c8328df [file] [log] [blame]
Ghanshyam1f47cf92016-02-25 04:57:18 +09001.. _api_microversion_testing:
2
Frédéric Guillot8160f082016-11-25 10:40:40 -05003API Microversion Testing Support in Tempest
Ghanshyam1f47cf92016-02-25 04:57:18 +09004===========================================
5
6---------------------------------------------
7Framework to support API Microversion testing
8---------------------------------------------
9
10Many of the OpenStack components have implemented API microversions.
ghanshyamc3b0b8b2016-03-16 11:58:34 +090011It is important to test those microversions in Tempest or external plugins.
Martin Kopecd76178e2024-01-16 20:43:56 +010012Tempest now provides stable interfaces to support testing the API microversions.
Ghanshyam1f47cf92016-02-25 04:57:18 +090013Based on the microversion range coming from the combination of both configuration
Martin Kopecd76178e2024-01-16 20:43:56 +010014and each test case, APIs requests will be made with the selected microversion.
Ghanshyam1f47cf92016-02-25 04:57:18 +090015
16This document explains the interfaces needed for microversion testing.
17
18
19The api_version_request module
20""""""""""""""""""""""""""""""
21
22.. automodule:: tempest.lib.common.api_version_request
23 :members:
24
25The api_version_utils module
26""""""""""""""""""""""""""""
27
28.. automodule:: tempest.lib.common.api_version_utils
29 :members: