[nexus] [trivial] Fix doc comments on RouteDestination (#6582)

oxidecomputer · Sep 16, 2024 · a7d942f · a7d942f
1 parent 8b59cae
commit a7d942f
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 11 deletions.
diff --git a/common/src/api/external/mod.rs b/common/src/api/external/mod.rs
@@ -1411,8 +1411,8 @@ pub enum RouteTarget {
     Drop,
 }
 
-/// A `RouteDestination` is used to match traffic with a routing rule, on the
-/// destination of that traffic.
+/// A `RouteDestination` is used to match traffic with a routing rule based on
+/// the destination of that traffic.
 ///
 /// When traffic is to be sent to a destination that is within a given
 /// `RouteDestination`, the corresponding `RouterRoute` applies, and traffic
@@ -1430,13 +1430,13 @@ pub enum RouteTarget {
 #[serde(tag = "type", content = "value", rename_all = "snake_case")]
 #[display("{}:{0}", style = "lowercase")]
 pub enum RouteDestination {
-    /// Route applies to traffic destined for a specific IP address
+    /// Route applies to traffic destined for the specified IP address
     Ip(IpAddr),
-    /// Route applies to traffic destined for a specific IP subnet
+    /// Route applies to traffic destined for the specified IP subnet
     IpNet(IpNet),
-    /// Route applies to traffic destined for the given VPC.
+    /// Route applies to traffic destined for the specified VPC
     Vpc(Name),
-    /// Route applies to traffic
+    /// Route applies to traffic destined for the specified VPC subnet
     Subnet(Name),
 }
 

diff --git a/openapi/nexus.json b/openapi/nexus.json
@@ -17372,10 +17372,10 @@
         ]
       },
       "RouteDestination": {
-        "description": "A `RouteDestination` is used to match traffic with a routing rule, on the destination of that traffic.\n\nWhen traffic is to be sent to a destination that is within a given `RouteDestination`, the corresponding `RouterRoute` applies, and traffic will be forward to the `RouteTarget` for that rule.",
+        "description": "A `RouteDestination` is used to match traffic with a routing rule based on the destination of that traffic.\n\nWhen traffic is to be sent to a destination that is within a given `RouteDestination`, the corresponding `RouterRoute` applies, and traffic will be forward to the `RouteTarget` for that rule.",
         "oneOf": [
           {
-            "description": "Route applies to traffic destined for a specific IP address",
+            "description": "Route applies to traffic destined for the specified IP address",
             "type": "object",
             "properties": {
               "type": {
@@ -17395,7 +17395,7 @@
             ]
           },
           {
-            "description": "Route applies to traffic destined for a specific IP subnet",
+            "description": "Route applies to traffic destined for the specified IP subnet",
             "type": "object",
             "properties": {
               "type": {
@@ -17414,7 +17414,7 @@
             ]
           },
           {
-            "description": "Route applies to traffic destined for the given VPC.",
+            "description": "Route applies to traffic destined for the specified VPC",
             "type": "object",
             "properties": {
               "type": {
@@ -17433,7 +17433,7 @@
             ]
           },
           {
-            "description": "Route applies to traffic",
+            "description": "Route applies to traffic destined for the specified VPC subnet",
             "type": "object",
             "properties": {
               "type": {