starlingx/metal
Code Issues Proposed changes

Fix reference to LLDP neighbors API path in the documentation

Browse Source 
This commit fixes the documentation so that the API path to get LLDP
neighbors reflect the spelling used in the code. The path in the code
is lldp_neighbours, and in the documentation was lldp_neighbors.

Test plan

[PASS] API paths in documentation are shown as */lldp_neighbours/*
       instead of */lldp_neighbors/*

Partial-Bug: #2054707
Change-Id: If1b1dc205b398cf050585c995bbc2ce985b29c40
Signed-off-by: Lucas Ratusznei Fonseca <lucas.ratuszneifonseca@windriver.com>
This commit is contained in:
Lucas Ratusznei Fonseca 2024-02-22 15:37:45 -03:00
parent 880df77a25
commit 33a4be37bc
1 changed files with 6 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
api-ref/source/api-ref-sysinv-v1-metal.rst
View File

@ -1598,11 +1598,11 @@ badMediaType (415)
"target_load": "16.10", "target_load": "16.10",
"lldp_neighbours": [ "lldp_neighbours": [
{ {
"href": "http://10.10.10.2:6385/v1/ihosts/bed0aee2-d637-488e-ada1-c837ee503f95/lldp_neighbors", "href": "http://10.10.10.2:6385/v1/ihosts/bed0aee2-d637-488e-ada1-c837ee503f95/lldp_neighbours",
"rel": "self" "rel": "self"
}, },
{ {
"href": "http://10.10.10.2:6385/ihosts/bed0aee2-d637-488e-ada1-c837ee503f95/lldp_neighbors", "href": "http://10.10.10.2:6385/ihosts/bed0aee2-d637-488e-ada1-c837ee503f95/lldp_neighbours",
"rel": "bookmark" "rel": "bookmark"
} }
], ],
@ -1896,11 +1896,11 @@ badMediaType (415)
"target_load": "15.12", "target_load": "15.12",
"lldp_neighbours": [ "lldp_neighbours": [
{ {
"href": "http://10.10.10.2:6385/v1/ihosts/e6c1a877-a332-46dd-821d-e5fa9e2c4ade/lldp_neighbors", "href": "http://10.10.10.2:6385/v1/ihosts/e6c1a877-a332-46dd-821d-e5fa9e2c4ade/lldp_neighbours",
"rel": "self" "rel": "self"
}, },
{ {
"href": "http://10.10.10.2:6385/ihosts/e6c1a877-a332-46dd-821d-e5fa9e2c4ade/lldp_neighbors", "href": "http://10.10.10.2:6385/ihosts/e6c1a877-a332-46dd-821d-e5fa9e2c4ade/lldp_neighbours",
"rel": "bookmark" "rel": "bookmark"
} }
], ],
@ -4226,7 +4226,7 @@ attributes.
List the LLDP neighbors of a host List the LLDP neighbors of a host
*********************************** ***********************************
.. rest_method:: GET /v1/lldp_neighbors .. rest_method:: GET /v1/lldp_neighbours
**Normal response codes** **Normal response codes**
@ -4319,7 +4319,7 @@ This operation does not accept a request body.
Shows the attributes of a specific LLDP neighbor Shows the attributes of a specific LLDP neighbor
************************************************** **************************************************
.. rest_method:: GET /v1/lldp_neighbors/​{lldp_neighbor_id}​ .. rest_method:: GET /v1/lldp_neighbours/​{lldp_neighbor_id}​
**Normal response codes** **Normal response codes**