Version Types

This schema file defines all types related to versioning.

This element is returned when the version of the resource cannot be determined. The element provides a list of choices for the resource.

Provides a list of supported versions.

This element provides detailed meta information regarding the status of the current API version. The description should include a pointer to both a human readable and a machine processable description of the API service.

The VersionStatus type describes a service's operational status. This is a new service the API. Thi API contract may be set, but the implementaiton may not be 100% complient with it. Developers are encouraged to begin testing aganst an ALPHA version to provide feedback. A status of BETA indicates that this version is a candidate for the next major release and may feature functionality not available in the current version. Developers are encouraged to test and begin the migration processes to a BETA version. Note that a BETA version is undergoing testing, it has not been officially released, and my not be stable. The API version is stable and has been tested. Developers are encouraged to develop against this API version. The current released version of the API will always be marked as CURRENT. A status of DEPRECATED indicates that a newer version of the API is available. Application developers are discouraged from using this version and should instead develop against the latest current version of the API. A version choice list outlines a collection of resources at various versions. In version lists, every single version must contain at least one self link. When used as a root element, a version choice must contain at least one describedby link. A version choice contains relevant information about an available service that a user can then use to target a specific version of the service. The ID of a version choice represents the service version's unique identifier. This ID is guaranteed to be unique only among the service version choices outlined in the VersionChoiceList. A version choice's status describes the current operational state of the given service version. The operational status is captured in a simple type enumeration called VersionStatus. A version choice's updated attribute describes the time when the version was updated. The time should be updated anytime anything in the version has changed: documentation, extensions, bug fixes. A MediaTypeList outlines a collection of valid media types for a given service version. A MediaType describes what content types the service version understands. The base of a given media type describes the simple MIME type that then a more complicated media type can be derived from. These types are basic and provide no namespace or version specific data are are only provided as a convenience. The type attribute of a MediaType describes the MIME specific identifier of the media type in question.