openstack/neutron-lib
Code Issues Proposed changes
Files
688b135d86188848e214bd2ac18e92f9120b4be9
neutron-lib/api-ref/source/v2/sfc-classifiers.inc
Brian Haley c28b3ab8fe Fix incorrect links for the filtering spec 
The spec networking_general_api_information.html was moved
to api-ref in [0] but some of the links pointing to it
were not updated. This change makes all the refs consistent
and adds links where missing.

Also moved sync/async and bulk create sections lower to
group all the filtering, pagination and sorting sections
together since they are inter-related.

[0] https://review.opendev.org/c/openstack/neutron-lib/+/362877

Change-Id: I895cc9aaee2546b95e93150c134f350a50346447
2024-04-04 19:00:17 -04:00

235 lines
5.7 KiB
ReStructuredText
Raw Blame History

.. -*- rst -*-
.. needs:method_verification
.. needs:parameter_verification
.. needs:example_verification
.. needs:body_verification
===================================
Flow Classifiers (flow-classifiers)
===================================
Lists, shows information for, creates, updates and deletes flow classifiers.
List Flow Classifiers
=====================
.. rest_method:: GET /v1.0/sfc/flow_classifiers
Lists flow classifiers.
.. include:: filtering-list.inc
Normal response codes: 200
Error response codes: unauthorized(401), forbidden(403)
Response
--------
.. rest_parameters:: parameters.yaml
- flow_classifier_id: flow_classifier_id-path
- name: classifier_name
- description: description
Response Example
----------------
**Example List flow classifiers: JSON response**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-list-resp.json
:language: javascript
Create Flow Classifier
======================
.. rest_method:: POST /v1.0/sfc/flow_classifiers
Creates a flow classifier.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403)
Request
-------
.. rest_parameters:: parameters.yaml
- name: classifier_name
- description: description
- ethertype: ethertype
- protocol: protocol
- source_port_range_min: source_port_range_min
- source_port_range_max: source_port_range_max
- destination_port_range_min: destination_port_range_min
- destination_port_range_max: destination_port_range_max
- source_ip_prefix: source_ip_prefix
- destination_ip_prefix: destination_ip_prefix
- source_logical_port: source_logical_port
- destination_logical_port: destination_logical_port
- l7_parameters: l7_parameters
Request Example
---------------
**Example Create flow classifier: JSON request**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-create-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- flow_classifier_id: flow_classifier_id-path
- name: classifier_name
- description: description
- ethertype: ethertype
- protocol: protocol
- source_port_range_min: source_port_range_min
- source_port_range_max: source_port_range_max
- destination_port_range_min: destination_port_range_min
- destination_port_range_max: destination_port_range_max
- source_ip_prefix: source_ip_prefix
- destination_ip_prefix: destination_ip_prefix
- source_logical_port: source_logical_port
- destination_logical_port: destination_logical_port
- l7_parameters: l7_parameters
Response Example
----------------
**Example Create flow classifier: JSON response**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-create-resp.json
:language: javascript
Show Flow Classifier Details
============================
.. rest_method:: GET /v1.0/sfc/flow_classifiers/{flow_classifier_id}
Shows details for a flow classifier.
.. include:: filtering-show.inc
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- flow_classifier_id: flow_classifier_id-path
Response
--------
.. rest_parameters:: parameters.yaml
- id: flow_classifier_id
- name: classifier_name
- description: description
- ethertype: ethertype
- protocol: protocol
- source_port_range_min: source_port_range_min
- source_port_range_max: source_port_range_max
- destination_port_range_min: destination_port_range_min
- destination_port_range_max: destination_port_range_max
- source_ip_prefix: source_ip_prefix
- destination_ip_prefix: destination_ip_prefix
- source_logical_port: source_logical_port
- destination_logical_port: destination_logical_port
- l7_parameters: l7_parameters
Response Example
----------------
**Example Show flow classifier: JSON response**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-get-resp.json
:language: javascript
Update Flow Classifier
======================
.. rest_method:: PUT /v1.0/sfc/flow_classifiers/{flow_classifier_id}
Updates a flow classifier.
Normal response codes: 200
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- flow_classifier_id: flow_classifier_id-path
- name: classifier_name
- description: description
Request Example
---------------
**Example Update flow classifier: JSON request**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-update-req.json
:language: javascript
Response
--------
.. rest_parameters:: parameters.yaml
- id: flow_classifier_id
- name: classifier_name
- description: description
- ethertype: ethertype
- protocol: protocol
- source_port_range_min: source_port_range_min
- source_port_range_max: source_port_range_max
- destination_port_range_min: destination_port_range_min
- destination_port_range_max: destination_port_range_max
- source_ip_prefix: source_ip_prefix
- destination_ip_prefix: destination_ip_prefix
- source_logical_port: source_logical_port
- destination_logical_port: destination_logical_port
- l7_parameters: l7_parameters
Response Example
----------------
**Example Update flow classifier: JSON response**
.. literalinclude:: samples/sfc-classifiers/flow-classifier-update-resp.json
:language: javascript
Delete Flow Classifier
======================
.. rest_method:: DELETE /v1.0/sfc/flow-classifiers/{flow_classifier_id}
Deletes a flow classifier.
Normal response codes: 202
Error response codes: badRequest(400), unauthorized(401), forbidden(403), itemNotFound(404)
Request
-------
.. rest_parameters:: parameters.yaml
- flow_classifier_id: flow_classifier_id-path
Response
--------
There is no body content for the response of a successful Delete request.
View Git Blame Copy Permalink