mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2025-02-25 18:55:28 -06:00
24bca144a8
The API version the client sends can now be used to check what the client expects or is capable of. All version tests IPA does will be be named and listed in one module, ipalib.capabilities, which includes a function to test a specific capability against an API version. Similarly to Python's __future__ module, capabilities.py also serves as documentation of backwards-incompatible changes to the API. The first capability to be defined is "messages". Recent enough clients can accept a list of warnings or other info under the "messages" key in the result dict. If a JSON client does not send the API version, it is assumed this is a testing client (e.g. curl from the command line). Such a client "has" all capabilities, but it will always receive a warning mentioning that forward compatibility is not guaranteed. If a XML client does not send the API version, it is assumed it uses the API version before capabilities were introduced. (This is to keep backwards compatibility with clients containing bug https://fedorahosted.org/freeipa/ticket/3294) Whenever a capability is added, the API version must be incremented. To ensure that, capabilities are written to API.txt and checked by `makeapi --validate`. Design page: http://freeipa.org/page/V3/Messages Ticket: https://fedorahosted.org/freeipa/ticket/2732
93 lines
4.4 KiB
Plaintext
93 lines
4.4 KiB
Plaintext
########################################################
|
|
# freeIPA Version #
|
|
# #
|
|
# freeIPA versions are as follows #
|
|
# 1.0.x New production series #
|
|
# 1.0.x{pre,beta,rc}y Preview/Testing, Beta & RC #
|
|
# 1.0.0GITabcdefg Build from GIT #
|
|
# #
|
|
########################################################
|
|
|
|
########################################################
|
|
# This are the main version numbers #
|
|
# #
|
|
# <MAJOR>.<MINOR>.<RELEASE> #
|
|
# #
|
|
# e.g. IPA_VERSION_MAJOR=1 #
|
|
# IPA_VERSION_MINOR=0 #
|
|
# IPA_VERSION_RELEASE=0 #
|
|
# -> "1.0.0" #
|
|
########################################################
|
|
IPA_VERSION_MAJOR=3
|
|
IPA_VERSION_MINOR=1
|
|
IPA_VERSION_RELEASE=0
|
|
|
|
########################################################
|
|
# For 'pre' releases the version will be #
|
|
# #
|
|
# <MAJOR>.<MINOR>.<RELEASE>pre<PRE_RELEASE> #
|
|
# #
|
|
# e.g. IPA_VERSION_PRE_RELEASE=1 #
|
|
# -> "1.0.0pre1" #
|
|
########################################################
|
|
IPA_VERSION_PRE_RELEASE=
|
|
|
|
########################################################
|
|
# For 'beta' releases the version will be #
|
|
# #
|
|
# <MAJOR>.<MINOR>.<RELEASE>beta<BETA_RELEASE> #
|
|
# #
|
|
# e.g. IPA_VERSION_BETA_RELEASE=1 #
|
|
# -> "1.0.0beta1" #
|
|
########################################################
|
|
IPA_VERSION_BETA_RELEASE=
|
|
|
|
########################################################
|
|
# For 'rc' releases the version will be #
|
|
# #
|
|
# <MAJOR>.<MINOR>.<RELEASE>rc<RC_RELEASE> #
|
|
# #
|
|
# e.g. IPA_VERSION_RC_RELEASE=1 #
|
|
# -> "1.0.0rc1" #
|
|
########################################################
|
|
IPA_VERSION_RC_RELEASE=
|
|
|
|
########################################################
|
|
# To mark GIT snapshots this should be set to 'yes' #
|
|
# in the development BRANCH, and set to 'no' only in #
|
|
# the IPA_X_X_RELEASE BRANCH #
|
|
# #
|
|
# <MAJOR>.<MINOR>.<RELEASE>GITxxx #
|
|
# #
|
|
# e.g. IPA_VERSION_IS_SVN_SNAPSHOT=yes #
|
|
# -> "1.0.0GITabcdefg" #
|
|
########################################################
|
|
IPA_VERSION_IS_GIT_SNAPSHOT="yes"
|
|
|
|
########################################################
|
|
# The version of IPA data. This is used to identify #
|
|
# incompatibilities in data that could cause issues #
|
|
# with replication. If the built-in versions don't #
|
|
# match exactly then replication will fail. #
|
|
# #
|
|
# The format is %Y%m%d%H%M%S #
|
|
# #
|
|
# e.g. IPA_DATA_VERSION=`date +%Y%m%d%H%M%S` #
|
|
# -> "20100614120000" #
|
|
########################################################
|
|
IPA_DATA_VERSION=20100614120000
|
|
|
|
########################################################
|
|
# The version of the IPA API. This controls which #
|
|
# client versions can use the XML-RPC and json APIs #
|
|
# #
|
|
# A change to existing API requires a MAJOR version #
|
|
# update. The addition of new API bumps the MINOR #
|
|
# version. #
|
|
# #
|
|
# The format is a whole number #
|
|
# #
|
|
########################################################
|
|
IPA_API_VERSION_MAJOR=2
|
|
IPA_API_VERSION_MINOR=52
|