tacker/api-ref/source/v1/nfps.inc
Naoya Harada 4a0b5c4569 API reference documentation
This patch follows on api-ref skeleton [1] and brings the
NFV Orchestration API reference content to the repository.
It is a part of the effort described in [2].

[1] https://review.openstack.org/#/c/332183
[2] https://wiki.openstack.org/wiki/Documentation/Migrate#API_Reference_Plan

Change-Id: Ia2d91adb33f10df9073de74eb82cc19be29a3da2
2016-12-01 14:17:47 +09:00

99 lines
1.6 KiB
ReStructuredText

.. -*- rst -*-
===============================
Network Forwarding Paths (NFPs)
===============================
Lists Network Forwarding Paths (NFPs) and shows information of a given NFP.
The NFP is a component of VNFFG and contains a Service Function Chain (SFC)
and a classifier.
List NFPs
=========
.. rest_method:: GET /v1.0/nfps
Lists NFPs.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 500
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- nfps: nfps
- status: nfp_status
- name: name
- tenant_id: tenant_id
- chain_id: sfc_id
- path_id: sfc_path_id
- symmetrical: symmetrical
- classifier_id: classifier_id
- id: nfp_id
Response Example
----------------
.. literalinclude:: samples/nfps/nfps-list-response.json
:language: javascript
Show NFP
========
.. rest_method:: GET /v1.0/nfps/{nfp_id}
Shows information of a given NFP.
Response Codes
--------------
.. rest_status_code:: success status.yaml
- 200
.. rest_status_code:: error status.yaml
- 401
- 404
- 500
Request Parameters
------------------
.. rest_parameters:: parameters.yaml
- nfp_id: nfp_id_path
Response Parameters
-------------------
.. rest_parameters:: parameters.yaml
- nfp: nfp
- status: nfp_status
- name: name
- tenant_id: tenant_id
- chain_id: sfc_id
- path_id: sfc_path_id
- symmetrical: symmetrical
- classifier_id: classifier_id
- id: nfp_id
Response Example
----------------
.. literalinclude:: samples/nfps/nfps-show-response.json
:language: javascript