No api-ref support in vmware-nsx
Bug #1601861 reported by
Boden R
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-
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://
[2] http://
[3] https:/
Changed in vmware-nsx: | |
assignee: | nobody → Boden R (boden) |
Changed in vmware-nsx: | |
status: | New → In Progress |
To post a comment you must log in.
Reviewed: https:/ /review. openstack. org/372754 /git.openstack. org/cgit/ openstack/ vmware- nsx/commit/ ?id=32d9a3023f2 b20dc6b636fddfe 7f2221d3ce3cfd
Committed: https:/
Submitter: Jenkins
Branch: master
commit 32d9a3023f2b20d c6b636fddfe7f22 21d3ce3cfd
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: /github. com/bodenr/ vmware- nsx/blob/ api-ref/ api-ref/ rest.md
https:/
Moving forward we can keep this doc in sync with our /github. com/openstack/ vmware- nsx/tree/ stable/{REL}/api- ref/rest. md
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:/
Closes-Bug: #1601861
Change-Id: Id2af02fc629c39 8835ea216cfc19d 8bbf583fa4c