Fix endpoint description casing (#4742)

Noticed some inconsistencies with the endpoint descriptions. Fixes oxidecomputer/docs#253
oxidecomputer · Jan 2, 2024 · cfcf209 · cfcf209
1 parent 9274beb
commit cfcf209
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 14 deletions.
diff --git a/nexus/src/external_api/http_entrypoints.rs b/nexus/src/external_api/http_entrypoints.rs
@@ -1294,7 +1294,7 @@ async fn project_policy_update(
 
 // IP Pools
 
-/// List all IP Pools that can be used by a given project.
+/// List all IP pools that can be used by a given project
 #[endpoint {
     method = GET,
     path = "/v1/ip-pools",
@@ -1452,7 +1452,7 @@ async fn ip_pool_view(
     apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
 }
 
-/// Delete an IP Pool
+/// Delete an IP pool
 #[endpoint {
     method = DELETE,
     path = "/v1/system/ip-pools/{pool}",
@@ -1474,7 +1474,7 @@ async fn ip_pool_delete(
     apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
 }
 
-/// Update an IP Pool
+/// Update an IP pool
 #[endpoint {
     method = PUT,
     path = "/v1/system/ip-pools/{pool}",
@@ -1701,7 +1701,7 @@ async fn ip_pool_service_range_remove(
 
 // Floating IP Addresses
 
-/// List all Floating IPs
+/// List all floating IPs
 #[endpoint {
     method = GET,
     path = "/v1/floating-ips",
@@ -1733,7 +1733,7 @@ async fn floating_ip_list(
     apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
 }
 
-/// Create a Floating IP
+/// Create a floating IP
 #[endpoint {
     method = POST,
     path = "/v1/floating-ips",
@@ -1759,7 +1759,7 @@ async fn floating_ip_create(
     apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
 }
 
-/// Delete a Floating IP
+/// Delete a floating IP
 #[endpoint {
     method = DELETE,
     path = "/v1/floating-ips/{floating_ip}",
@@ -4757,7 +4757,7 @@ async fn sled_view(
     apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await
 }
 
-/// Set the sled's provision state.
+/// Set the sled's provision state
 #[endpoint {
     method = PUT,
     path = "/v1/system/hardware/sleds/{sled_id}/provision-state",

diff --git a/openapi/nexus.json b/openapi/nexus.json
@@ -809,7 +809,7 @@
         "tags": [
           "floating-ips"
         ],
-        "summary": "List all Floating IPs",
+        "summary": "List all floating IPs",
         "operationId": "floating_ip_list",
         "parameters": [
           {
@@ -876,7 +876,7 @@
         "tags": [
           "floating-ips"
         ],
-        "summary": "Create a Floating IP",
+        "summary": "Create a floating IP",
         "operationId": "floating_ip_create",
         "parameters": [
           {
@@ -968,7 +968,7 @@
         "tags": [
           "floating-ips"
         ],
-        "summary": "Delete a Floating IP",
+        "summary": "Delete a floating IP",
         "operationId": "floating_ip_delete",
         "parameters": [
           {
@@ -2154,7 +2154,7 @@
         "tags": [
           "projects"
         ],
-        "summary": "List all IP Pools that can be used by a given project.",
+        "summary": "List all IP pools that can be used by a given project",
         "operationId": "project_ip_pool_list",
         "parameters": [
           {
@@ -3971,7 +3971,7 @@
         "tags": [
           "system/hardware"
         ],
-        "summary": "Set the sled's provision state.",
+        "summary": "Set the sled's provision state",
         "operationId": "sled_set_provision_state",
         "parameters": [
           {
@@ -4783,7 +4783,7 @@
         "tags": [
           "system/networking"
         ],
-        "summary": "Update an IP Pool",
+        "summary": "Update an IP pool",
         "operationId": "ip_pool_update",
         "parameters": [
           {
@@ -4829,7 +4829,7 @@
         "tags": [
           "system/networking"
         ],
-        "summary": "Delete an IP Pool",
+        "summary": "Delete an IP pool",
         "operationId": "ip_pool_delete",
         "parameters": [
           {