Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[nexus] [minor] Bring BGP endpoint doc comments in line with conventions #4329

Merged
merged 1 commit into from
Oct 24, 2023
Merged

[nexus] [minor] Bring BGP endpoint doc comments in line with conventions #4329

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions nexus/src/external_api/http_entrypoints.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2609,7 +2609,7 @@ async fn networking_loopback_address_delete(
apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
}

/// Get loopback addresses, optionally filtering by id
/// List loopback addresses
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Didn't think "optionally filtering by id" is necessary, also not sure it's even true

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, good catch. That's a remnant of an earlier version.

#[endpoint {
method = GET,
path = "/v1/system/networking/loopback-address",
Expand Down Expand Up @@ -2824,7 +2824,7 @@ async fn networking_switch_port_clear_settings(
apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
}

/// Create a new BGP configuration.
/// Create a new BGP configuration
#[endpoint {
method = POST,
path = "/v1/system/networking/bgp",
Expand All @@ -2845,7 +2845,7 @@ async fn networking_bgp_config_create(
apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
}

/// Get BGP configurations.
/// List BGP configurations
#[endpoint {
method = GET,
path = "/v1/system/networking/bgp",
Expand Down Expand Up @@ -2900,7 +2900,7 @@ async fn networking_bgp_status(
}

//TODO pagination? the normal by-name/by-id stuff does not work here
/// Get imported IPv4 BGP routes.
/// Get imported IPv4 BGP routes
#[endpoint {
method = GET,
path = "/v1/system/networking/bgp-routes-ipv4",
Expand All @@ -2921,7 +2921,7 @@ async fn networking_bgp_imported_routes_ipv4(
apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
}

/// Delete a BGP configuration.
/// Delete a BGP configuration
#[endpoint {
method = DELETE,
path = "/v1/system/networking/bgp",
Expand All @@ -2942,7 +2942,7 @@ async fn networking_bgp_config_delete(
apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
}

/// Create a new BGP announce set.
/// Create a new BGP announce set
#[endpoint {
method = POST,
path = "/v1/system/networking/bgp-announce",
Expand All @@ -2964,7 +2964,7 @@ async fn networking_bgp_announce_set_create(
}

//TODO pagination? the normal by-name/by-id stuff does not work here
/// Get originated routes for a given BGP configuration.
/// Get originated routes for a BGP configuration
#[endpoint {
method = GET,
path = "/v1/system/networking/bgp-announce",
Expand All @@ -2990,7 +2990,7 @@ async fn networking_bgp_announce_set_list(
apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
}

/// Delete a BGP announce set.
/// Delete a BGP announce set
#[endpoint {
method = DELETE,
path = "/v1/system/networking/bgp-announce",
Expand Down
16 changes: 8 additions & 8 deletions openapi/nexus.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5170,7 +5170,7 @@
"tags": [
"system/networking"
],
"summary": "Get BGP configurations.",
"summary": "List BGP configurations",
"operationId": "networking_bgp_config_list",
"parameters": [
{
Expand Down Expand Up @@ -5235,7 +5235,7 @@
"tags": [
"system/networking"
],
"summary": "Create a new BGP configuration.",
"summary": "Create a new BGP configuration",
"operationId": "networking_bgp_config_create",
"requestBody": {
"content": {
Expand Down Expand Up @@ -5270,7 +5270,7 @@
"tags": [
"system/networking"
],
"summary": "Delete a BGP configuration.",
"summary": "Delete a BGP configuration",
"operationId": "networking_bgp_config_delete",
"parameters": [
{
Expand Down Expand Up @@ -5301,7 +5301,7 @@
"tags": [
"system/networking"
],
"summary": "Get originated routes for a given BGP configuration.",
"summary": "Get originated routes for a BGP configuration",
"operationId": "networking_bgp_announce_set_list",
"parameters": [
{
Expand Down Expand Up @@ -5341,7 +5341,7 @@
"tags": [
"system/networking"
],
"summary": "Create a new BGP announce set.",
"summary": "Create a new BGP announce set",
"operationId": "networking_bgp_announce_set_create",
"requestBody": {
"content": {
Expand Down Expand Up @@ -5376,7 +5376,7 @@
"tags": [
"system/networking"
],
"summary": "Delete a BGP announce set.",
"summary": "Delete a BGP announce set",
"operationId": "networking_bgp_announce_set_delete",
"parameters": [
{
Expand Down Expand Up @@ -5407,7 +5407,7 @@
"tags": [
"system/networking"
],
"summary": "Get imported IPv4 BGP routes.",
"summary": "Get imported IPv4 BGP routes",
"operationId": "networking_bgp_imported_routes_ipv4",
"parameters": [
{
Expand Down Expand Up @@ -5482,7 +5482,7 @@
"tags": [
"system/networking"
],
"summary": "Get loopback addresses, optionally filtering by id",
"summary": "List loopback addresses",
"operationId": "networking_loopback_address_list",
"parameters": [
{
Expand Down
Loading