diff --git a/common/src/api/external/mod.rs b/common/src/api/external/mod.rs index dd27d49e01..1ddb5be864 100644 --- a/common/src/api/external/mod.rs +++ b/common/src/api/external/mod.rs @@ -1570,9 +1570,9 @@ pub struct RouterRoute { pub vpc_router_id: Uuid, /// Describes the kind of router. Set at creation. `read-only` pub kind: RouterRouteKind, - /// The location that matched packets should be forwarded to. + /// The location that matched packets should be forwarded to pub target: RouteTarget, - /// Selects which traffic this routing rule will apply to. + /// Selects which traffic this routing rule will apply to pub destination: RouteDestination, } @@ -1581,9 +1581,9 @@ pub struct InternetGatewayIpPool { /// Common identifying metadata #[serde(flatten)] pub identity: IdentityMetadata, - /// The ID of the internet gateway to which the IP pool entry belongs. + /// The ID of the internet gateway to which the IP pool entry belongs pub internet_gateway_id: Uuid, - /// The ID of the referenced IP pool. + /// The ID of the referenced IP pool pub ip_pool_id: Uuid, } @@ -1592,9 +1592,9 @@ pub struct InternetGatewayIp { /// Common identifying metadata #[serde(flatten)] pub identity: IdentityMetadata, - /// The ID of the internet gateway to which the IP belongs. + /// The ID of the internet gateway to which the IP belongs pub internet_gateway_id: Uuid, - /// The IP address. + /// The IP address pub address: IpAddr, } diff --git a/nexus/external-api/src/lib.rs b/nexus/external-api/src/lib.rs index 01679c5a12..9c414d8981 100644 --- a/nexus/external-api/src/lib.rs +++ b/nexus/external-api/src/lib.rs @@ -2257,7 +2257,7 @@ pub trait NexusExternalApi { query_params: Query, ) -> Result; - /// List IP pools attached to an internet gateway. + /// List IP pools attached to internet gateway #[endpoint { method = GET, path = "/v1/internet-gateway-ip-pools", @@ -2273,7 +2273,7 @@ pub trait NexusExternalApi { HttpError, >; - /// Attach ip pool to internet gateway + /// Attach IP pool to internet gateway #[endpoint { method = POST, path = "/v1/internet-gateway-ip-pools", @@ -2285,7 +2285,7 @@ pub trait NexusExternalApi { create_params: TypedBody, ) -> Result, HttpError>; - /// Detach ip pool from internet gateway + /// Detach IP pool from internet gateway #[endpoint { method = DELETE, path = "/v1/internet-gateway-ip-pools/{pool}", @@ -2297,7 +2297,7 @@ pub trait NexusExternalApi { query_params: Query, ) -> Result; - /// List addresses attached to an internet gateway. + /// List IP addresses attached to internet gateway #[endpoint { method = GET, path = "/v1/internet-gateway-ip-addresses", @@ -2313,7 +2313,7 @@ pub trait NexusExternalApi { HttpError, >; - /// Attach ip pool to internet gateway + /// Attach IP pool to internet gateway #[endpoint { method = POST, path = "/v1/internet-gateway-ip-addresses", @@ -2325,7 +2325,7 @@ pub trait NexusExternalApi { create_params: TypedBody, ) -> Result, HttpError>; - /// Detach ip pool from internet gateway + /// Detach IP pool from internet gateway #[endpoint { method = DELETE, path = "/v1/internet-gateway-ip-addresses/{address}", @@ -3173,6 +3173,6 @@ pub fn validate_api(spec: &OpenAPI, mut cx: ValidationContext<'_>) { pub type IpPoolRangePaginationParams = PaginationParams; -/// Type used to paginate request to list timeseries schema. +/// Type used to paginate request to list timeseries schema pub type TimeseriesSchemaPaginationParams = PaginationParams; diff --git a/openapi/nexus.json b/openapi/nexus.json index ecaf428404..846b14829b 100644 --- a/openapi/nexus.json +++ b/openapi/nexus.json @@ -2681,7 +2681,7 @@ "tags": [ "vpcs" ], - "summary": "List addresses attached to an internet gateway.", + "summary": "List IP addresses attached to internet gateway", "operationId": "internet_gateway_ip_address_list", "parameters": [ { @@ -2764,7 +2764,7 @@ "tags": [ "vpcs" ], - "summary": "Attach ip pool to internet gateway", + "summary": "Attach IP pool to internet gateway", "operationId": "internet_gateway_ip_address_create", "parameters": [ { @@ -2828,7 +2828,7 @@ "tags": [ "vpcs" ], - "summary": "Detach ip pool from internet gateway", + "summary": "Detach IP pool from internet gateway", "operationId": "internet_gateway_ip_address_delete", "parameters": [ { @@ -2891,7 +2891,7 @@ "tags": [ "vpcs" ], - "summary": "List IP pools attached to an internet gateway.", + "summary": "List IP pools attached to internet gateway", "operationId": "internet_gateway_ip_pool_list", "parameters": [ { @@ -2974,7 +2974,7 @@ "tags": [ "vpcs" ], - "summary": "Attach ip pool to internet gateway", + "summary": "Attach IP pool to internet gateway", "operationId": "internet_gateway_ip_pool_create", "parameters": [ { @@ -3038,7 +3038,7 @@ "tags": [ "vpcs" ], - "summary": "Detach ip pool from internet gateway", + "summary": "Detach IP pool from internet gateway", "operationId": "internet_gateway_ip_pool_delete", "parameters": [ { @@ -18674,7 +18674,7 @@ "type": "string" }, "destination": { - "description": "Selects which traffic this routing rule will apply to.", + "description": "Selects which traffic this routing rule will apply to", "allOf": [ { "$ref": "#/components/schemas/RouteDestination" @@ -18703,7 +18703,7 @@ ] }, "target": { - "description": "The location that matched packets should be forwarded to.", + "description": "The location that matched packets should be forwarded to", "allOf": [ { "$ref": "#/components/schemas/RouteTarget"