Versioning

Types of Releases for REST APIs

The REST APIs follow similar release stages as other PubSub+ Products. You can view a description of each release stage in the customer documentation at PubSub+ Cloud Release Stages Overview. The REST APIs have three versions:

• General Availablity (GA)
• Beta
• Early Access

GA REST APIs have strict requirements concerning backward compatibility compared with other API versions. When developing for production environments, we recommend using GA APIs.

You can find the details of each REST API release stage below.

General Availability (GA)

For GA releases, the APIs are:

• complete, stable, and fully supported
• fully documented
• if (Early Access) or (Beta) are not visible in the documentation, the API is GA
• publicly available
• any breaking changes follow a deprecation strategy

Beta

For Beta releases, the APIs are:

• fully featured with fewer changes
• documented and marked as (Beta)
• publicly available
• breaking changes may occur, but are less likely

Early Access (EA)

For EA releases, the APIs are:

• under active development and marked (Early Access)
• may not be documented
• breaking changes should be expected
• not guaranteed to become Generally Available

Deprecation of REST APIs

Deprecation of a Generally Available REST API indicates that Solace plans to remove it in the near future. Typically, deprecated REST APIs are replaced with improved alternatives offering enhanced functionality. When any part of a REST API is deprecated-such as an entire endpoint, a query parameter, or a request/response property-the response includes an X-Solace-API-Deprecated header in the response of the endpoint. The header provides a link to the documentation with the deprecation details. Deprecation may apply to:

• An entire REST API endpoint
• A query parameter
• A request or response property, or entire object

Deprecation Details

All deprecated API endpoints, parameters, or objects indicate the deprecation date,
removal date, and reason in their descriptions:

• Deprecation Date—The ISO 8601-formatted date of when the deprecation was announced.
• Removal Date—The ISO 8601-formatted date when the API is scheduled for removal.
• Reason—The reason for deprecation, along with any recommended alternatives (e.g., endpoints, parameters, or objects).

Deprecation Policy

By default, a deprecated REST API is removed 12 months after its deprecation date,
as specified in its Removal Date. The removal date is subject to change based on
customer and business requirements. This deprecation policy does not apply to APIs in the Beta
or Early Access stages, which may change or be removed without notice.

📘

Note

Emergency changes to the PubSub+ Cloud REST API may be necessary to address critical issues such as security vulnerabilities or specification violations. These changes could potentially break compatibility and may not adhere to standard deprecation policies.