Got it! Shall we support both Accept header and URL context for this? Thanks
On Mon, Oct 6, 2014 at 2:39 PM, Nirmal Fernando <[email protected]> wrote: > Hi Imesh, > > Yes, GitHub API does that way https://developer.github.com/v3/versions/ > > > On Mon, Oct 6, 2014 at 2:35 PM, Imesh Gunaratne <[email protected]> wrote: > >> +1 Regarding point 2: using Accept header to specify the API version, is >> this being done by any other known APIs? For my understanding Accept header >> is used for specify the media type [1]. >> >> [1] http://www.w3.org/Protocols/rfc2616/rfc2616-sec14.html >> >> On Sun, Oct 5, 2014 at 9:27 PM, Nirmal Fernando <[email protected]> >> wrote: >> >>> All, >>> >>> Let's discuss how we could do $subject properly. AFAIS currently we >>> don't have any versioning in our REST API, but we have consumers of our >>> REST API. >>> >>> 1. We can make the default API version to be the latest version, i.e. v2. >>> >>> So, if someone send a request to /<rootContext>/cartridges , it would >>> find /<rootContext>/v2/cartridges >>> >>> 2. Anyone can use the default API paths and still could request for a >>> specific version via HTTP Accept Header. >>> >>> Accept: application/vnd.stratos.v1+json >>> >>> >>> 3. Provide a migration guide for existing Clients. >>> >>> - If they want to use the old API, they need to specifically request for >>> the old API, by specifying the Accept header. >>> >>> 4. Mark v1 API as deprecated and announce that we'll remove the support >>> for it in the next release. >>> >>> Any other alternatives? >>> >>> >>> -- >>> Best Regards, >>> Nirmal >>> >>> Nirmal Fernando. >>> PPMC Member & Committer of Apache Stratos, >>> Senior Software Engineer, WSO2 Inc. >>> >>> Blog: http://nirmalfdo.blogspot.com/ >>> >> >> >> >> -- >> Imesh Gunaratne >> >> Technical Lead, WSO2 >> Committer & PMC Member, Apache Stratos >> > > > > -- > Best Regards, > Nirmal > > Nirmal Fernando. > PPMC Member & Committer of Apache Stratos, > Senior Software Engineer, WSO2 Inc. > > Blog: http://nirmalfdo.blogspot.com/ > -- Imesh Gunaratne Technical Lead, WSO2 Committer & PMC Member, Apache Stratos
