openstack/tacker
Code Issues Proposed changes
4a2cce57c2
tacker/api-ref/source/index.rst

28 lines
435 B
ReStructuredText
Raw Normal View History

Initial api-ref skeleton for Tacker This patch is the first step to bring the NFV Orchestration API Reference to the repository. It is a part of the effort described here [1]: [1] https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan Once this skeleton patch is merged, an api-ref job can be added to the gate. The gate job makes it much easier to review API Reference contents, which will be brought by follow-on patches. Change-Id: I7cc587f2c7b3c546be9cd11bad7e3b4eeacad171 Co-Authored-By: Naoya Harada <n-harada@vx.jp.nec.com>
2016-06-21 16:53:06 +02:00
==============================
NFV Orchestration Service APIs
==============================
Add documents for multi-version API support This patch provides Tacker documents for multi-version API support. VNF LCM API Version 2 is added to API Reference and the page hierarchy is changed for readability. Also, the Show VNF LCM Versions command is added to Command-Line Interface Reference. Furthermore, a manual of the Userdata script is added to Tacker User Guide. Implements: blueprint multi-version-api Implements: blueprint support-nfv-solv3-start-and-terminate-vnf Implements: blueprint support-nfv-solv3-query-vnf-instances Implements: blueprint support-nfv-solv3-query-operation-occurrences Implements: blueprint support-nfv-solv3-subscriptions Change-Id: I603e32090303af080b17e549a0caf7e862aa7e1e
2021-09-08 18:32:33 +09:00
NFV Orchestration API v1.0
--------------------------
.. toctree::
:maxdepth: 1
v1/legacy
v1/vnfpkgm
v1/vnflcm_versions
v1/vnflcm
NFV Orchestration API v2.0
--------------------------
Initial api-ref skeleton for Tacker This patch is the first step to bring the NFV Orchestration API Reference to the repository. It is a part of the effort described here [1]: [1] https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan Once this skeleton patch is merged, an api-ref job can be added to the gate. The gate job makes it much easier to review API Reference contents, which will be brought by follow-on patches. Change-Id: I7cc587f2c7b3c546be9cd11bad7e3b4eeacad171 Co-Authored-By: Naoya Harada <n-harada@vx.jp.nec.com>
2016-06-21 16:53:06 +02:00
.. toctree::
:maxdepth: 1
Add documents for multi-version API support This patch provides Tacker documents for multi-version API support. VNF LCM API Version 2 is added to API Reference and the page hierarchy is changed for readability. Also, the Show VNF LCM Versions command is added to Command-Line Interface Reference. Furthermore, a manual of the Userdata script is added to Tacker User Guide. Implements: blueprint multi-version-api Implements: blueprint support-nfv-solv3-start-and-terminate-vnf Implements: blueprint support-nfv-solv3-query-vnf-instances Implements: blueprint support-nfv-solv3-query-operation-occurrences Implements: blueprint support-nfv-solv3-subscriptions Change-Id: I603e32090303af080b17e549a0caf7e862aa7e1e
2021-09-08 18:32:33 +09:00
v1/vnflcm_versions
v2/vnflcm
Add docs for cnf auto heal and scale This patch makes the following updates to the API and CLI docs. * Add support cnf auto heal and scale Implements: blueprint support-auto-lcm Change-Id: I776637f1361aa5861d42fb98e71ebabd3825ca4c
2022-09-07 18:21:54 +09:00
v2/vnffm
v2/vnfpm
v2/prometheus_plugin
Add docs for faultnotification auto heal This patch makes the following updates to the API and CLI docs. * Add support faultnotification auto heal Implements: blueprint support-autoheal-queue Change-Id: I2fcb3c54ef3cca4e79bf701daebf1286a36f730c
2022-09-07 15:13:48 +09:00
v2/fault_notification
Copy Permalink