Versioned Core Gadget Features

The feature you want to use in your OpenSocial application (“opensocial”, “minimessage”, etc.) is declared by using Require element or Optional element. Then, the way to specify the version you want to use the feature was vague until now. To specify the version definitely, “Versioned Core Gadget Features” specification is added to OpenSocial specification 1.0.

The abstract of this specification is below:

The OpenSocial features (as used in gadget or elements) were defined with the version number as part of the name (“opensocial-0.7″, “opensocial-0.8″, etc.)

This lets them evolve from one version to the next without breaking backwards compatibility, and allows gadgets to clearly declare which version of the API they require.

This convention should be formalized in an explicit version attribute on the and elements, with versions defined for all of the features described by the OpenSocial specification.

As a special case, the core gadget spec format and rendering process should be versioned, with gadgets requesting a specific version of the specification using an attribute on the root element.

For instance, the following two point is added as the format for gadget xml file:

  • Added @specificationVersion attribute to Module root element.
  • Added @version attribute to Require and Optional elements.

For example, the usage is the following code:


  
    
  
  ...

If the specificationVersion or version attribute is omitted, it is regarded as the version 1.0 is specified. Each values can be ordered three numbers by divided using period.

MajorVersion.MinorVersion.PatchVersion

PatchVersion and MinorVersion can be omitted. In the above example, PatchVersion is omitted from the specificationVersion. This thinking about each item is same of the thinking for the general it of the versioning.

Based on this specification, the version number for all features included a name space called “gadgets” are basically 1.0.0.

The unclear point like “The feature called “opensocial” has the version number “opensocial-0.8″. Why is there no version number for osapi?” will be think once more based on this specification.

Trackback URL:

Leave a Reply

You must be logged in to post a comment.

Get Adobe Flash playerPlugin by wpburn.com wordpress themes