From 33a4be37bcceac912dc2e4d9f3621b189a20eb0b Mon Sep 17 00:00:00 2001 From: Lucas Ratusznei Fonseca Date: Thu, 22 Feb 2024 15:37:45 -0300 Subject: [PATCH] Fix reference to LLDP neighbors API path in the documentation 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 --- api-ref/source/api-ref-sysinv-v1-metal.rst | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/api-ref/source/api-ref-sysinv-v1-metal.rst b/api-ref/source/api-ref-sysinv-v1-metal.rst index 278fa260..57f9f1d3 100644 --- a/api-ref/source/api-ref-sysinv-v1-metal.rst +++ b/api-ref/source/api-ref-sysinv-v1-metal.rst @@ -1598,11 +1598,11 @@ badMediaType (415) "target_load": "16.10", "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" }, { - "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" } ], @@ -1896,11 +1896,11 @@ badMediaType (415) "target_load": "15.12", "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" }, { - "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" } ], @@ -4226,7 +4226,7 @@ attributes. List the LLDP neighbors of a host *********************************** -.. rest_method:: GET /v1/lldp_neighbors +.. rest_method:: GET /v1/lldp_neighbours **Normal response codes** @@ -4319,7 +4319,7 @@ This operation does not accept a request body. 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**