Cisco Unity Connection Provisioning Interface (CUPI) API -- About Versioning

From DocWiki

(Difference between revisions)
Jump to: navigation, search
 
(One intermediate revision not shown)
Line 32: Line 32:
Adding a new resource means adding a new URL, not changing existing URLs. This means that existing client code can continue to run against the new version without change.
Adding a new resource means adding a new URL, not changing existing URLs. This means that existing client code can continue to run against the new version without change.
 +
[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]
[[Category:Cisco Unity Connection Provisioning Interface (CUPI) API]]

Latest revision as of 00:59, 14 December 2010

Links to Other API pages: Cisco_Unity_Connection_APIs

CUPI Guide Contents
API Overview
Index of All CUPI Documentation

Contents


About Versioning

Cisco Unity Connection REST interfaces essentially are not versioned. There are several mechanisms in place to ease forward and backward compatibility:

1. The version is available as a resource at /vmrest/version:

<VersionInformation>
  <name>vmrest</name>
  <version>8.0.0.229</version>
</VersionInformation>

2. Extra fields in a resource are ignored by the server.

This means that if we add a field to a resource in a future release, and the new resource is sent to an older server, the operation will complete (with the exception of updating the field that it does not have).

3. Clients ignore new fields.

The XML schema files that are provided for clients include a provision for arbitrary fields to be added at the end. This means that when a new field is added to a resource exposed by the server, it will not affect client code.

4. New resources are added at new URLs.

Adding a new resource means adding a new URL, not changing existing URLs. This means that existing client code can continue to run against the new version without change.

Rating: 0.0/5 (0 votes cast)

Personal tools