propagate doc comments to api specs

oxidecomputer · May 2, 2024 · 31f7848 · 31f7848
1 parent 3534abf
commit 31f7848
Show file tree

Hide file tree

Showing 8 changed files with 20 additions and 20 deletions.
diff --git a/common/src/api/internal/shared.rs b/common/src/api/internal/shared.rs
@@ -227,7 +227,7 @@ pub struct BgpPeerConfig {
     /// Apply a local preference to routes received from this peer.
     #[serde(default)]
     pub local_pref: Option<u32>,
-    /// Enforce that the first AS in paths recieved from this peer is the peer's AS.
+    /// Enforce that the first AS in paths received from this peer is the peer's AS.
     #[serde(default)]
     pub enforce_first_as: bool,
 }

diff --git a/nexus/types/src/external_api/params.rs b/nexus/types/src/external_api/params.rs
@@ -1767,7 +1767,7 @@ pub struct BgpPeer {
     /// Apply a local preference to routes received from this peer.
     pub local_pref: Option<u32>,
 
-    /// Enforce that the first AS in paths recieved from this peer is the peer's AS.
+    /// Enforce that the first AS in paths received from this peer is the peer's AS.
     pub enforce_first_as: bool,
 }
 

diff --git a/openapi/bootstrap-agent.json b/openapi/bootstrap-agent.json
@@ -285,7 +285,7 @@
           },
           "checker": {
             "nullable": true,
-            "description": "Checker to apply to incomming messages.",
+            "description": "Checker to apply to incoming messages.",
             "default": null,
             "type": "string"
           },
@@ -347,7 +347,7 @@
             "minimum": 0
           },
           "enforce_first_as": {
-            "description": "Enforce that the first AS in paths recieved from this peer is the peer's AS.",
+            "description": "Enforce that the first AS in paths received from this peer is the peer's AS.",
             "default": false,
             "type": "boolean"
           },
@@ -408,7 +408,7 @@
           },
           "remote_asn": {
             "nullable": true,
-            "description": "Requre that a peer has a specified ASN.",
+            "description": "Require that a peer has a specified ASN.",
             "default": null,
             "type": "integer",
             "format": "uint32",

diff --git a/openapi/nexus-internal.json b/openapi/nexus-internal.json
@@ -1524,7 +1524,7 @@
           },
           "checker": {
             "nullable": true,
-            "description": "Checker to apply to incomming messages.",
+            "description": "Checker to apply to incoming messages.",
             "default": null,
             "type": "string"
           },
@@ -1586,7 +1586,7 @@
             "minimum": 0
           },
           "enforce_first_as": {
-            "description": "Enforce that the first AS in paths recieved from this peer is the peer's AS.",
+            "description": "Enforce that the first AS in paths received from this peer is the peer's AS.",
             "default": false,
             "type": "boolean"
           },
@@ -1647,7 +1647,7 @@
           },
           "remote_asn": {
             "nullable": true,
-            "description": "Requre that a peer has a specified ASN.",
+            "description": "Require that a peer has a specified ASN.",
             "default": null,
             "type": "integer",
             "format": "uint32",

diff --git a/openapi/nexus.json b/openapi/nexus.json
@@ -9493,7 +9493,7 @@
           },
           "checker": {
             "nullable": true,
-            "description": "A checker program to apply to incomming open and update messages.",
+            "description": "A checker program to apply to incoming open and update messages.",
             "type": "string"
           },
           "description": {
@@ -9632,7 +9632,7 @@
             "minimum": 0
           },
           "enforce_first_as": {
-            "description": "Enforce that the first AS in paths recieved from this peer is the peer's AS.",
+            "description": "Enforce that the first AS in paths received from this peer is the peer's AS.",
             "type": "boolean"
           },
           "hold_time": {
@@ -9685,7 +9685,7 @@
           },
           "remote_asn": {
             "nullable": true,
-            "description": "Requre that a peer has a specified ASN.",
+            "description": "Require that a peer has a specified ASN.",
             "type": "integer",
             "format": "uint32",
             "minimum": 0

diff --git a/openapi/sled-agent.json b/openapi/sled-agent.json
@@ -1432,7 +1432,7 @@
           },
           "checker": {
             "nullable": true,
-            "description": "Checker to apply to incomming messages.",
+            "description": "Checker to apply to incoming messages.",
             "default": null,
             "type": "string"
           },
@@ -1494,7 +1494,7 @@
             "minimum": 0
           },
           "enforce_first_as": {
-            "description": "Enforce that the first AS in paths recieved from this peer is the peer's AS.",
+            "description": "Enforce that the first AS in paths received from this peer is the peer's AS.",
             "default": false,
             "type": "boolean"
           },
@@ -1555,7 +1555,7 @@
           },
           "remote_asn": {
             "nullable": true,
-            "description": "Requre that a peer has a specified ASN.",
+            "description": "Require that a peer has a specified ASN.",
             "default": null,
             "type": "integer",
             "format": "uint32",

diff --git a/openapi/wicketd.json b/openapi/wicketd.json
@@ -824,7 +824,7 @@
           },
           "checker": {
             "nullable": true,
-            "description": "Checker to apply to incomming messages.",
+            "description": "Checker to apply to incoming messages.",
             "default": null,
             "type": "string"
           },
@@ -886,7 +886,7 @@
             "minimum": 0
           },
           "enforce_first_as": {
-            "description": "Enforce that the first AS in paths recieved from this peer is the peer's AS.",
+            "description": "Enforce that the first AS in paths received from this peer is the peer's AS.",
             "default": false,
             "type": "boolean"
           },
@@ -947,7 +947,7 @@
           },
           "remote_asn": {
             "nullable": true,
-            "description": "Requre that a peer has a specified ASN.",
+            "description": "Require that a peer has a specified ASN.",
             "default": null,
             "type": "integer",
             "format": "uint32",

diff --git a/schema/rss-sled-plan.json b/schema/rss-sled-plan.json
@@ -152,7 +152,7 @@
           "minimum": 0.0
         },
         "checker": {
-          "description": "Checker to apply to incomming messages.",
+          "description": "Checker to apply to incoming messages.",
           "default": null,
           "type": [
             "string",
@@ -224,7 +224,7 @@
           "minimum": 0.0
         },
         "enforce_first_as": {
-          "description": "Enforce that the first AS in paths recieved from this peer is the peer's AS.",
+          "description": "Enforce that the first AS in paths received from this peer is the peer's AS.",
           "default": false,
           "type": "boolean"
         },
@@ -298,7 +298,7 @@
           "type": "string"
         },
         "remote_asn": {
-          "description": "Requre that a peer has a specified ASN.",
+          "description": "Require that a peer has a specified ASN.",
           "default": null,
           "type": [
             "integer",