Defining a connector version
The Connector Development Kit follows semantic versioning standards for connector version control. Based on the semantic versioning standards, there are 3 parts to a version, major, minor, and patch, which is
described in the form Major.Minor.Patch. For example, in the version 1.2.3, '1' is the major version, '2' is the minor version, and '3' is the patch version. A version must only include numeric characters and a period
(.) with no spaces. If no version is provided while creating a new connector, the default version 1.0.0 is used.
Important: When you update the major, minor, or patch version information by using Connector Development Kit or manually in the OpenAPI document for any breaking or nonbreaking changes, the system doesn't validate the type of change made. The system only checks the connector version information and the name to determine the replacements. It is your responsibility to ensure that the major, minor, or patch version information is updated according to the provided guidelines.
Restrictions on upgrading and downgrading connector versions
When upgrading or downgrading the connector version in the Connector Development Kit, certain restrictions apply for major, minor, or patch version updates. The following table describes allowed and not allowed conditions for version updates.
| Allowed | Not allowed |
|---|---|
| You can upgrade the minor and patch version of the connector | You cannot downgrade the minor and patch version of the connector |
| You can upgrade or downgrade the major version of the connector |
Criteria for version updates
When you decide to update the major, minor, or patch versions, you need to consider certain criteria before deciding which version to update. This would depend on the type of change you are performing on the connector.
The decision to update
the major, minor, or patch versions should be based on the following criteria:
- Criteria for major version updates
- Criteria for minor version updates
- Criteria for patch version updates
Criteria for major version updates
The major version of the connector is updated when there are breaking changes in the connector. The following are some scenarios that require updating the major version.
- New required field added to request parameters
- New required field added to filter parameters
- New schema updated for request or response parameters
- Changing the field from optional to required
- Updating the method type for an action
- Updating the group of an action
- Updating the group name
- Updating the action type for an action
- The array of properties in the Response tab is changed
- Type updated for the field
- Updates to pagination
- When the connector supports a new endpoint API version
- Any changes to the Connection properties tab
- Any changes in the Events tab (for example, selecting or deselecting an event, or any update)
Criteria for minor version updates
The minor version of the connector is updated when there are additive or nonbreaking changes in the connector. The following are some scenarios that require updating the minor version.
- New group added
- New action added
- New optional field added to request parameters
- New optional field added to response parameters
- New optional field added to filter parameters
Criteria for patch version updates
The patch version of the connector is updated when you perform changes compatible with an earlier version or bug fixes in the connector. The following are some scenarios that require updating the patch version.
- Default value added or updated for an existing field
- Action name update
- Summary update for an action
- Description updated for an action
- Display name update for a field
- Description updated for a field
- Connector description update
- Category, Secondary category, or Family field updated
- Connector icon update