diff --git a/nexus/types/src/external_api/headers.rs b/nexus/types/src/external_api/headers.rs index 58cf8e854e..e928e8f5c6 100644 --- 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 - /// ``` - /// - /// + /// See: pub range: Option, } diff --git a/openapi/nexus-internal.json b/openapi/nexus-internal.json index 1be773dbb9..7e6a4e7acd 100644 --- 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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "schema": { "type": "string" } diff --git a/openapi/nexus.json b/openapi/nexus.json index 0f23a68fc0..76f2e44f6c 100644 --- 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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "schema": { "type": "string" } diff --git a/openapi/sled-agent.json b/openapi/sled-agent.json index 3f28d8b7ba..c04084e07f 100644 --- 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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "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", + "description": "A request to access a portion of the resource, such as `bytes=0-499`\n\nSee: ", "schema": { "type": "string" } diff --git a/sled-agent/api/src/lib.rs b/sled-agent/api/src/lib.rs index 6c6cca6cf3..da9c0c77c4 100644 --- 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 - /// ``` - /// - /// + /// See: pub range: Option, }