Activity Versioning
Activity Versioning
Daon reserves the right to add new parameters to Activities without advance notice. These updates are non-breaking because they are additive. Breaking changes such as removing or renaming a parameter are released as a new version of the Activity.
In order to ensure that the Activities for TrustX can evolve and improve as required, the Activities for TrustX Process Definitions are versioned. If and when a breaking change needs to be applied, then a new version of Activity will be published.
- The following changes are considered to be backwards-compatible:
- The addition of new Activities.
- The addition of new optional input parameters to existing Activities.
- The addition of new output parameters to existing Activities.
- The addition of newly supported enumerated value for the values of input or output parameters.
- The change in order of input and output parameters of existing Activities.
Default values may be applied by the server where new optional input parameters fields are expected. In this case the new default value is applied to ensure that the operation performs as before.
The following Activities changes are not considered to be backwards-compatible. The changes would constitute a breaking change, without a deprecation notice, and will require the publication of a new Activity or Activity version:
The removal, addition or renaming of a required input parameters.
The removal or renaming of an output parameters.
The change of semantics to any input parameter.
The removal of any previously supported enumerated value.
Changes to authentication or authorization requirements.
Deprecation of Activities
If any Activity is deemed to to be unnecessary, unmaintainable, outdated or unsafe then they may be marked as deprecated. Notice of intent to deprecate shall be provided in order to give those with integrations opportunity to migrate. Deprecated Activities shall be supported for the given notice period after such time support for the deprecated Activity shall be removed.
If Process Definitions with deprecated Activities are not updated within the deprecation period then it is likely that your application will fail to process correctly.
Session Data
Session Data are attributes created during the execution of a process instance and is both used and generated by Activities and are governed under similar version rules.
Daon reserves the right to add new fields & structures to Session Data without advance notice. These updates are nonbreaking because they are additive. Breaking changes such as removing or renaming a field are released as a new ‘resource’ within the Session Data.
The following changes are considered to be backwards-compatible:
The addition of new data structures within Session Data.
The addition of new fields to existing data structures within Session Data.
The addition of new enumerated values for fields of data structures within Session Data.
The change in order of data structures within Session Data.
Changes in length of fields such as error messages and error strings.
Empty or null values may omitted from the fields of data structures within Session Data.
Default values may be applied by the server where new optional parameters, HTTP headers or fields are expected. In this case the new default value is applied to ensure that the operation performs as before.
The following changes are not considered to be backwards-compatible. The changes would constitute a breaking change, without a deprecation notice, and will require the publication of a new data structure.
The removal or renaming of an data structures.
The removal or renaming of a data structure within Session Data.
The change of semantics to any field within Session Data.
The removal of any previously supported enumerated value.
Deprecation of Session Data
If any data structure within Session Data is deemed to to be unnecessary, unmaintainable, outdated or unsafe then they may be marked as deprecated. Notice of intent to deprecate shall be provided in order to give those with integrations opportunity to migrate. Deprecated data structure within Session Data shall be supported for the given notice period after such time support for the deprecated data structure within Session Data shall be removed.
The deprecation of data structures within Session Data will typically be linked to the deprecation of a Activity.
If Process Definitions using deprecated data structure within Session Data structure are not updated within the deprecation period then it is likely that your application will fail to process correctly.
Compatibility Rules
Do not consume any TrustX Session Data data structures unless it is documented on this site. All undocumented data structures should be considered private, subject to change without notice, and not covered by any agreements.