Web space in ovirt.org for the REST API documentation

[Juan Hernández]

On 05/31/2016 01:56 PM, Juan Hernández wrote:
> On 05/31/2016 01:47 PM, Eyal Edri wrote:
>> I think you should submit content to ovirt-site project, as described in:
>> https://github.com/oVirt/ovirt-site
>>
> 
> I will try that, lets see how it works.
> 

I have just created the following pull request:

  Add engine API explorer
  https://github.com/oVirt/ovirt-site/pull/274

Note that it contains two very large files: index.js and model.json. The
first is the result of the build process of the JavaScript application.
The second is the description of the API specification, in JSON format.

Please review.

>> On Tue, May 31, 2016 at 2:45 PM, Juan Hernández <jhernand at redhat.com
>> <mailto:jhernand at redhat.com>> wrote:
>>
>>     On 12/15/2015 10:48 AM, Eyal Edri wrote:
>>     > Adding Mikey.
>>     >
>>     > On Tue, Dec 15, 2015 at 11:46 AM, Juan Hernández <jhernand at redhat.com <mailto:jhernand at redhat.com>
>>     > <mailto:jhernand at redhat.com <mailto:jhernand at redhat.com>>> wrote:
>>     >
>>     >     Hello,
>>     >
>>     >     Version 4.0 of the oVirt Engine API will include automatically generated
>>     >     documentation of the API. This will be included in the server itself,
>>     >     probably in a URL like
>>     >     "http://engine.example.com/ovir-engine/api/explorer". I would like to
>>     >     have this same documentation available in "ovirt.org <http://ovirt.org>
>>     >     <http://ovirt.org>", so that users
>>     >     that don't have a server installed can still use the documentation,
>>     >     something like this:
>>     >
>>     >       https://jhernand.fedorapeople.org/ovirt-api-explorer/#/home
>>     >
>>     >     The documentation and the application used to explore it require approx
>>     >     20 MiB of space, for each version of the API (currently only one,
>>     >     version 4).
>>     >
>>     >     Eventually this web site should be updated by a Jenkins job as part of
>>     >     the release process.
>>     >
>>     >     Can we host this in ovirt.org <http://ovirt.org>
>>     <http://ovirt.org>?
>>     >
>>     >     Regards,
>>     >     Juan Hernandez
>>     >
>>
>>     I'd like to resume work on this. It is possible to have some web space
>>     for this content?
>>
> 


-- 
Dirección Comercial: C/Jose Bardasano Baos, 9, Edif. Gorbea 3, planta
3ºD, 28016 Madrid, Spain
Inscrita en el Reg. Mercantil de Madrid – C.I.F. B82657941 - Red Hat S.L.