No api-ref support in vmware-nsx

Bug #1601861 reported by Boden R
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
vmware-nsx
Fix Released
Undecided
Boden R

Bug Description

Many of the core openstack projects are moving towards a per-project approach for documenting their REST API via api-ref [1].

For example, the neutron-lib gate-neutron-lib-api-ref job [2] that builds the api-ref/source [3].

We should follow suit in vmware-nsx to help document our extension APIs for consumers.

This bug is to track getting a api-ref job + config stood up.

[1] http://docs.openstack.org/contributor-guide/api-guides.html
[2] http://docs-draft.openstack.org/10/333410/5/check/gate-neutron-lib-api-ref/14e1418//api-ref/build/html/
[3] https://github.com/openstack/neutron-lib/tree/master/api-ref/source

Boden R (boden)
Changed in vmware-nsx:
assignee: nobody → Boden R (boden)
Boden R (boden)
Changed in vmware-nsx:
status: New → In Progress
Revision history for this message
OpenStack Infra (hudson-openstack) wrote : Fix merged to vmware-nsx (master)

Reviewed: https://review.openstack.org/372754
Committed: https://git.openstack.org/cgit/openstack/vmware-nsx/commit/?id=32d9a3023f2b20dc6b636fddfe7f2221d3ce3cfd
Submitter: Jenkins
Branch: master

commit 32d9a3023f2b20dc6b636fddfe7f2221d3ce3cfd
Author: Boden R <email address hidden>
Date: Mon Sep 19 14:42:41 2016 -0600

    Add api-ref in MD format

    This commit creates a vmware-nsx REST API extension
    API reference document in github flavored markdown
    format. The API ref herein only includes extensions for
    NSX-v and NSX-v3 as MH will be deprecated.

    To view this document as-is rendered see:
    https://github.com/bodenr/vmware-nsx/blob/api-ref/api-ref/rest.md

    Moving forward we can keep this doc in sync with our
    plugins so that consumers can just view the git tag
    on github to see the related api ref for their release version
    of the plugin. e.g.
    https://github.com/openstack/vmware-nsx/tree/stable/{REL}/api-ref/rest.md

    Closes-Bug: #1601861

    Change-Id: Id2af02fc629c398835ea216cfc19d8bbf583fa4c

Changed in vmware-nsx:
status: In Progress → Fix Released
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.