openstack/neutron-lib
Code Issues Proposed changes

api-ref: fix nits in BGP-Speaker api-ref

Browse Source 
Change-Id: I6b4fac4bf6d74d15308ed740e74119d82709329f
This commit is contained in:
elajkat
2023-01-10 17:44:42 +01:00
parent 7e9f66aca4
commit 89820bede2
2 changed files with 28 additions and 6 deletions
Download Patch File Download Diff File Expand all files Collapse all files

31
api-ref/source/v2/bgp_speaker.inc
View File

@@ -207,7 +207,7 @@ There is no body content for the response of a successful DELETE request.
Add BGP Peer to a BGP Speaker
=============================
.. rest_method:: PUT /v2.0/bgp-speakers/<bgp-speaker-id>/add-bgp-peer
.. rest_method:: PUT /v2.0/bgp-speakers/{bgp-speaker-id}/add_bgp_peer
Bind the BGP peer to the specified BGP Speaker.
@@ -243,7 +243,7 @@ Response Example
Remove BGP Peer from a BGP Speaker
==================================
.. rest_method:: PUT /v2.0/bgp-speakers/<bgp-speaker-id>/remove-bgp-peer
.. rest_method:: PUT /v2.0/bgp-speakers/{bgp-speaker-id}/remove_bgp_peer
Unbind the BGP peer from a BGP Speaker.
@@ -271,7 +271,7 @@ There is no body content for the response of a successful DELETE request.
Add Network to a BGP Speaker
============================
.. rest_method:: PUT /v2.0/bgp-speakers/<bgp-speaker-id>/add_gateway_network
.. rest_method:: PUT /v2.0/bgp-speakers/{bgp-speaker-id}/add_gateway_network
Add a network to the specified BGP speaker.
@@ -308,16 +308,35 @@ Response Example
Delete Network from a BGP Speaker
=================================
.. rest_method:: PUT /v2.0/bgp-speakers/<bgp-speaker-id>/remove_gateway_network
.. rest_method:: PUT /v2.0/bgp-speakers/{bgp-speaker-id}/remove_gateway_network
Remove a network from the specified BGP speaker.
Normal response codes: 200
Request
-------
.. rest_parameters:: parameters.yaml
- bgp-speaker-id: bgp_speaker_id-path
- network_id: network_id
Request Example
---------------
.. literalinclude:: samples/bgp/bgp_speaker_remove_network-request.json
:language: javascript
Response
--------
There is no body content for the response of a successful DELETE request.
List routes advertised by a BGP Speaker
=======================================
.. rest_method:: GET /v2.0/bgp-speakers/<bgp-speaker-id>/get_advertised_routes
.. rest_method:: GET /v2.0/bgp-speakers/{bgp-speaker-id}/get_advertised_routes
List all routes advertised by the specified BGP Speaker.
@@ -341,7 +360,7 @@ Response Example
List Dynamic Routing Agents hosting a specific BGP Speaker
==========================================================
.. rest_method:: GET /v2.0/bgp-speakers/<bgp-speaker-id>/bgp-dragents
.. rest_method:: GET /v2.0/bgp-speakers/{bgp-speaker-id}/bgp-dragents
List all BGP dynamic agents which are hosting the specified BGP Speaker.

3
api-ref/source/v2/samples/bgp/bgp_speaker_remove_network-request.json Normal file
View File

@@ -0,0 +1,3 @@
{
"network_id":"f2269b61-6755-4174-8f64-5e318617b204"
}