Chapter 9 Cisco Crs-1 Series Xml Schema Versioning; Major And Minor Version Numbers - Cisco CRS-1 - Carrier Routing System Router Api Manual

Cisco CRS-1 Series XML Schema Versioning
Before the Cisco CRS-1 Series Carrier Routing System (Cisco CRS-1 Series) can carry out a client
application request, it must verify version compatibility between the client request and router component
versions.
A major and minor version number will be carried on the <Request> and <Response> elements to
indicate the overall Cisco CRS-1 Series XML application programming interface (API) version in use
by the client application and router. In addition, each component XML schema exposed through the
Cisco CRS-1 Series XML API will have a major and minor version number associated with it.
Note The XML API code is available for use on any Cisco platform that runs Cisco IOS XR software.
This chapter describes the format of the version information exchanged between the client application
and the Cisco CRS-1 Series router, and how the Cisco CRS-1 Series router uses this information at run
time to check version compatibility. The following sections are provided:
•
•
•

Major and Minor Version Numbers

The top-level or root object (that is, element) in each component XML schema carries the major and
minor version numbers for that schema. A minor version change is defined as an addition to the XML
schema. All other changes, including deletions and semantic changes, are considered major version
changes.
The version numbers are documented in the header comment contained in the XML schema file. They
are also available as <xsd:appinfo> annotations included as part of the complex type definition for the
top-level schema element. This will enable you to programmatically extract the version numbers from
the XML schema file to include in XML request instances sent to the router. The version numbers are
carried in the XML instances using the MajorVersion and MinorVersion attributes.
The following example shows the relevant portion of the complex type definition for an element that
carries version information:
<xsd:complexType name="ipv4_bgp_cfg_BGP_type">
<xsd:annotation>
OL-4596-01
"Major and Minor Version Numbers"
"Run-Time Use of Version Information"
"Retrieving Version Information"
<xsd:documentation>Global BGP config</xsd:documentation>
<xsd:appinfo>
C H A P T E R
Cisco CRS-1 Series Carrier Routing System XML API Guide
9
9-91