python-ironicclient/releasenotes/notes/allow-api-user-to-use-latest-6b80e9f584eaaa4e.yaml
Sharpz7 9bb0fcd05e [codespell] Fixing Spelling Mistakes
This is the first in a series of commits to add support for codespell. This is continuning the process completed in ironic-python-agent.

Future Commits will add a Tox Target, CI support and potentially a git-blame-ignore-revs file if their are lots of spelling mistakes that could clutter git blame.

Change-Id: Iab417bfd09cb0bf416982733933c29e49e3229eb
2024-01-29 23:22:19 +00:00

27 lines
1.2 KiB
YAML

---
features:
- |
Allows a python API user to pass ``latest`` to the client creation request
for the ``os_ironic_api_version`` parameter. The version utilized for REST
API requests will, as a result, be the highest available version
understood by both the ironicclient library and the server.
- |
Adds base client properties to provide insight to a python API user of
what the current REST API version that will be utilized, and if API
version negotiation has occurred.
These new properties are ``client.current_api_version`` and
``client.is_api_version_negotiated`` respectively.
- |
Adds additional base client method to allow a python API user to trigger
version negotiation and return the negotiated version. This new method is
``client.negotiate_api_version()``.
other:
- |
The maximum supported version supported for negotiation is now defined
in the ``common/http.py`` file. Any new feature added to the API client
library must increment this version.
- |
The maximum known version supported by the ``OpenStackClient`` plugin is
now defined by the maximum supported version for API negotiation as
defined in the ``common/http.py`` file.