[openstack-dev] [Heat] Questions about plans for heat wadls moving forward

Steve Baker sbaker at redhat.com
Wed Sep 18 19:08:06 UTC 2013


On 09/18/2013 08:09 AM, Mike Asthalter wrote:
> We were successful yesterday in accessing the orchestration-api wadl
> in the api-site repo from the api-ref dev guide
> (https://github.com/openstack/heat/blob/master/doc/docbkx/api-ref/src/docbkx/api-ref.xml)
> in the original heat repo using the following syntax in the
> api-ref.xml doc:
>
> <wadl:resources
>            
> href="http://git.openstack.org/cgit/openstack/api-site/plain/api-ref/src/wadls/orchestration-api/src/v1/orchestration-api.wadl"
>             xmlns:wadl="http://wadl.dev.java.net/2009/02"/>
>
>
> Therefore, as recommended in our discussion on this mailing list last
> week, I am planning to submit a patch to delete the original heat wadl
> (heat-api-1.0.wadl) and to point the api-ref.xml doc at the
> orchestration-api.wadl in the api-site repo, as shown above. 
>
> Please let me know by tomorrow if anyone has any objections to
> deleting the original heat wadl, heat-api-1.0.wadl.
>
There is already a change in progress to delete all of heat's api-ref
https://review.openstack.org/#/c/46412/

> On a related note, Anne Gentle has recommended the following:
>
> "What we also need to build is logic in the build jobs so that any
> time the api-site WADL is updated, your dev guide is also updated.
> This is done in the Jenkins job
> in https://github.com/openstack-infra/config/blob/master/modules/openstack_project/files/jenkins_job_builder/config/api-jobs.yaml.
> I can either submit this patch for you, or I'll ask Steve or Zane to
> do so."
>
> Steve or Zane, is submitting this patch for the build logic something
> you would like to do, or should we ask Anne to take care of it?
>
>
I would think that there is no need at all now for
heat/doc/docbkx/api-ref since it is part of api.site. Does this mean
there is no need for an update job?
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-dev/attachments/20130918/d9e0a8ad/attachment.html>


More information about the OpenStack-dev mailing list