For 1.0.x releases
I believe that in the Social API area the SPI is stable. However there will be some tension generated keeping this stable since implementations running in production may have heavily optimized implementations of parts of the SPI. If we change the SPI, we risk diverting requests from the optimized routes to new routes, which is almost as bad as changing the API.

There are one or two other API's that an integrator might implement, like the caching api. This are probably stable.

For 1.1 and later.
The next release of Shindig is targeting OpenSocial 0.9, which clarifies some areas of the model and makes extensions. I would expect the SPI to change, some methods may be deprecated, some may be added to address the changes in OpenSocial 0.9

It would be very good if we could come up with a shared view on the stability of the various API's. What versions of shindig are targeting which versions of the OpenSocial API and what integrators should expect. I have seen this done effectively in Jackrabbit where the JSR-283 spec has just been released, they have sent out brief roadmap statements relating the version 1.6 and 2.0 to JSR-283

Ian

On 23 Apr 2009, at 14:25, Mark D Weitzel wrote:

Quick question.... In thinking about the 1.0 release, are there any API
guidelines for Shindig? I know other apache projects and projects at
eclipse have published how they expect the APIs to stabilize over time
(see links). I was looking around for something similar for Shindig but
could not find it. The primary motivation for the question is that I'd
like to make sure I understand what compatibility guarantees we are making (if any) between versions, e.g. 1.0, 1.0.x, 1.x, and 2.0. This may already
be on the wiki or web site, and I just missed it.

Thanks,
-Mark W.

http://apr.apache.org/versioning.html
http://wiki.eclipse.org/API_Central
http://wiki.eclipse.org/Provisional_API_Guidelines
http://wiki.eclipse.org/Provisional_API_Guidelines_Update_Proposal

Reply via email to