From 8a6182ad8815c2127e9b399f1f5e7434e5c73372 Mon Sep 17 00:00:00 2001
From: Nils Nieuwejaar <nils@oxidecomputer.com>
Date: Sat, 16 Nov 2024 16:09:56 -0500
Subject: [PATCH] improve docstring for optional fec setting (#7083)

---
 common/src/api/external/mod.rs         | 4 +++-
 nexus/types/src/external_api/params.rs | 4 +++-
 openapi/nexus.json                     | 4 ++--
 3 files changed, 8 insertions(+), 4 deletions(-)

diff --git a/common/src/api/external/mod.rs b/common/src/api/external/mod.rs
index 0c0062d227..837c562f28 100644
--- 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
index 152e09275f..15bf7f9959 100644
--- 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
index a272b9167c..d4dfa6d391 100644
--- 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"