improve docstring for optional fec setting (#7083)

oxidecomputer · Nov 16, 2024 · 8a6182a · 8a6182a
1 parent 81184e3
commit 8a6182a
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 4 deletions.
diff --git a/common/src/api/external/mod.rs b/common/src/api/external/mod.rs
@@ -2513,7 +2513,9 @@ pub struct SwitchPortLinkConfig {
     /// The maximum transmission unit for this link.
     pub mtu: u16,
 
-    /// The forward error correction mode of the link.
+    /// The requested forward-error correction method.  If this is not
+    /// specified, the standard FEC for the underlying media will be applied
+    /// if it can be determined.
     pub fec: Option<LinkFec>,
 
     /// The configured speed of the link.

diff --git a/nexus/types/src/external_api/params.rs b/nexus/types/src/external_api/params.rs
@@ -1715,7 +1715,9 @@ pub struct LinkConfigCreate {
     /// The link-layer discovery protocol (LLDP) configuration for the link.
     pub lldp: LldpLinkConfigCreate,
 
-    /// The forward error correction mode of the link.
+    /// The requested forward-error correction method.  If this is not
+    /// specified, the standard FEC for the underlying media will be applied
+    /// if it can be determined.
     pub fec: Option<LinkFec>,
 
     /// The speed of the link.

diff --git a/openapi/nexus.json b/openapi/nexus.json
@@ -17167,7 +17167,7 @@
           },
           "fec": {
             "nullable": true,
-            "description": "The forward error correction mode of the link.",
+            "description": "The requested forward-error correction method.  If this is not specified, the standard FEC for the underlying media will be applied if it can be determined.",
             "allOf": [
               {
                 "$ref": "#/components/schemas/LinkFec"
@@ -20411,7 +20411,7 @@
           },
           "fec": {
             "nullable": true,
-            "description": "The forward error correction mode of the link.",
+            "description": "The requested forward-error correction method.  If this is not specified, the standard FEC for the underlying media will be applied if it can be determined.",
             "allOf": [
               {
                 "$ref": "#/components/schemas/LinkFec"