Update openapi doc comments to work around rustfmt bug (#8210)

smklein · web-flow · commit 37a2122e4be0 · 2025-05-27T16:57:25.000Z
Workaround to help integrate oxidecomputer/oxide.rs#1110
diff --git a/nexus/types/src/external_api/headers.rs b/nexus/types/src/external_api/headers.rs
@@ -9,12 +9,8 @@ use serde::Serialize;
 /// Range request headers
 #[derive(Debug, Deserialize, Serialize, JsonSchema)]
 pub struct RangeRequest {
-    /// A request to access a portion of the resource, such as:
+    /// A request to access a portion of the resource, such as `bytes=0-499`
     ///
-    /// ```text
-    /// bytes=0-499
-    /// ```
-    ///
-    /// <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>
+    /// See: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>
     pub range: Option<String>,
 }
diff --git a/openapi/nexus-internal.json b/openapi/nexus-internal.json
@@ -894,7 +894,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -928,7 +928,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -964,7 +964,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -1007,7 +1007,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -1052,7 +1052,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
diff --git a/openapi/nexus.json b/openapi/nexus.json
@@ -466,7 +466,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -503,7 +503,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -542,7 +542,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -588,7 +588,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -636,7 +636,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
diff --git a/openapi/sled-agent.json b/openapi/sled-agent.json
@@ -1126,7 +1126,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -1177,7 +1177,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -1230,7 +1230,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -1290,7 +1290,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -1352,7 +1352,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
@@ -1403,7 +1403,7 @@
           {
             "in": "header",
             "name": "range",
-            "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
+            "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
             "schema": {
               "type": "string"
             }
diff --git a/sled-agent/api/src/lib.rs b/sled-agent/api/src/lib.rs
@@ -820,13 +820,9 @@ pub struct SupportBundleMetadata {
 /// Range request headers
 #[derive(Debug, Deserialize, Serialize, JsonSchema)]
 pub struct RangeRequestHeaders {
-    /// A request to access a portion of the resource, such as:
+    /// A request to access a portion of the resource, such as `bytes=0-499`
     ///
-    /// ```text
-    /// bytes=0-499
-    /// ```
-    ///
-    /// <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>
+    /// See: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>
     pub range: Option<String>,
 }
 

Original file line number	Diff line number	Diff line change
`@@ -894,7 +894,7 @@`
`894`	`894`	`{`
`895`	`895`	`"in": "header",`
`896`	`896`	`"name": "range",`
`897`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`897`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`898`	`898`	`"schema": {`
`899`	`899`	`"type": "string"`
`900`	`900`	`}`
`@@ -928,7 +928,7 @@`
`928`	`928`	`{`
`929`	`929`	`"in": "header",`
`930`	`930`	`"name": "range",`
`931`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`931`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`932`	`932`	`"schema": {`
`933`	`933`	`"type": "string"`
`934`	`934`	`}`
`@@ -964,7 +964,7 @@`
`964`	`964`	`{`
`965`	`965`	`"in": "header",`
`966`	`966`	`"name": "range",`
`967`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`967`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`968`	`968`	`"schema": {`
`969`	`969`	`"type": "string"`
`970`	`970`	`}`
`@@ -1007,7 +1007,7 @@`
`1007`	`1007`	`{`
`1008`	`1008`	`"in": "header",`
`1009`	`1009`	`"name": "range",`
`1010`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`1010`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`1011`	`1011`	`"schema": {`
`1012`	`1012`	`"type": "string"`
`1013`	`1013`	`}`
`@@ -1052,7 +1052,7 @@`
`1052`	`1052`	`{`
`1053`	`1053`	`"in": "header",`
`1054`	`1054`	`"name": "range",`
`1055`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`1055`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`1056`	`1056`	`"schema": {`
`1057`	`1057`	`"type": "string"`
`1058`	`1058`	`}`
Original file line number	Diff line number	Diff line change
`@@ -466,7 +466,7 @@`
`466`	`466`	`{`
`467`	`467`	`"in": "header",`
`468`	`468`	`"name": "range",`
`469`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`469`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`470`	`470`	`"schema": {`
`471`	`471`	`"type": "string"`
`472`	`472`	`}`
`@@ -503,7 +503,7 @@`
`503`	`503`	`{`
`504`	`504`	`"in": "header",`
`505`	`505`	`"name": "range",`
`506`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`506`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`507`	`507`	`"schema": {`
`508`	`508`	`"type": "string"`
`509`	`509`	`}`
`@@ -542,7 +542,7 @@`
`542`	`542`	`{`
`543`	`543`	`"in": "header",`
`544`	`544`	`"name": "range",`
`545`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`545`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`546`	`546`	`"schema": {`
`547`	`547`	`"type": "string"`
`548`	`548`	`}`
`@@ -588,7 +588,7 @@`
`588`	`588`	`{`
`589`	`589`	`"in": "header",`
`590`	`590`	`"name": "range",`
`591`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`591`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`592`	`592`	`"schema": {`
`593`	`593`	`"type": "string"`
`594`	`594`	`}`
`@@ -636,7 +636,7 @@`
`636`	`636`	`{`
`637`	`637`	`"in": "header",`
`638`	`638`	`"name": "range",`
`639`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`639`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`640`	`640`	`"schema": {`
`641`	`641`	`"type": "string"`
`642`	`642`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1126,7 +1126,7 @@`
`1126`	`1126`	`{`
`1127`	`1127`	`"in": "header",`
`1128`	`1128`	`"name": "range",`
`1129`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`1129`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`1130`	`1130`	`"schema": {`
`1131`	`1131`	`"type": "string"`
`1132`	`1132`	`}`
`@@ -1177,7 +1177,7 @@`
`1177`	`1177`	`{`
`1178`	`1178`	`"in": "header",`
`1179`	`1179`	`"name": "range",`
`1180`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`1180`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`1181`	`1181`	`"schema": {`
`1182`	`1182`	`"type": "string"`
`1183`	`1183`	`}`
`@@ -1230,7 +1230,7 @@`
`1230`	`1230`	`{`
`1231`	`1231`	`"in": "header",`
`1232`	`1232`	`"name": "range",`
`1233`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`1233`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`1234`	`1234`	`"schema": {`
`1235`	`1235`	`"type": "string"`
`1236`	`1236`	`}`
`@@ -1290,7 +1290,7 @@`
`1290`	`1290`	`{`
`1291`	`1291`	`"in": "header",`
`1292`	`1292`	`"name": "range",`
`1293`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`1293`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`1294`	`1294`	`"schema": {`
`1295`	`1295`	`"type": "string"`
`1296`	`1296`	`}`
`@@ -1352,7 +1352,7 @@`
`1352`	`1352`	`{`
`1353`	`1353`	`"in": "header",`
`1354`	`1354`	`"name": "range",`
`1355`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`1355`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`1356`	`1356`	`"schema": {`
`1357`	`1357`	`"type": "string"`
`1358`	`1358`	`}`
`@@ -1403,7 +1403,7 @@`
`1403`	`1403`	`{`
`1404`	`1404`	`"in": "header",`
`1405`	`1405`	`"name": "range",`
`1406`		- "description": "A request to access a portion of the resource, such as:\n\n```text bytes=0-499 ```\n\n<https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
	`1406`	+ "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: <https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Range>",
`1407`	`1407`	`"schema": {`
`1408`	`1408`	`"type": "string"`
`1409`	`1409`	`}`