Re: [che-dev] REST API documentation on eclipseche.org

[Gennady Azarenkov <gazarenkov@xxxxxxxxxxx>]

Yes, we need to split Codenvy infra API and Che API documentation as soon as possible.

Thanks for reminding.

Gennady Azarenkov - CTO @ codenvy.com

On Sun, Jul 5, 2015 at 7:26 PM, Tyler Jewell <tyler@xxxxxxxxxxx> wrote:

Hi Lior:

The API set between Codenvy and Che should be identical, though their implementations different.  One difference is that hosted swagger gives a peruser of the API live expeimentation of the API against a hosted system.  One benefit to having Eclipseche.org host the Codenvy API is this live experimentation against a real system.

We have talked about potentially hosting Che to provide a live variant for Che, but we felt that the work was sizable and something we might look at next year after 4.x ships..

In the mean time API compatibility should be sufficient with a summary statement that calls out that Che is singler user / single workspace and Codenvy provides a different implementation of the same API.

 If there are blatant issues we will look at the unified API to improve there first to the benefit of both consumers.

Tyler Jewell | CEO | tyler@​codenvy.​com | 9​78​.8​84​.53​55

On Sun, Jul 5, 2015 at 7:47 AM, Okman, Lior <lior.okman@xxxxxxx> wrote:

Hi,

 

 

I happened to notice that the REST API documentation on eclipseche.org (http://eclipseche.org/docs/api/ ) was updated.

 

However, some of the APIs that are documented in the Eclipse Che project site are not actually available as part of Eclipse Che, but are rather APIs that are specific to the Codenvy offering. This is due to the fact that the Eclipse Che Swagger site is using https://codenvy.com/api/docs as its source, and that installation contains items that are not part of the open-source project offering.

 

Is it possible to update the Eclipse Che site, so that it is clear which APIs are part of the Che project, and the source-code is available as part of the Che project, and which APIs are part of the proprietary Codenvy solution? The REST API published in the Eclipse Che site should not contain documentation for non Che code.

 

 

Thanks,

Lior Okman

Area Architect, Development Experience, Technology Cloud Experience

SAP Labs Israel, 15 Hatidhar st., Raanana 43665, Israel

 

M  +972-54-338-8481

T   +972-9-777-9816

Lior.Okman@xxxxxxx

 

 

 

_______________________________________________
che-dev mailing list
che-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/che-dev

_______________________________________________
che-dev mailing list
che-dev@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://dev.eclipse.org/mailman/listinfo/che-dev