[nexus] OpenAPI schema not marking required query params required

[david-crespo]

The selector struct (correct)

InternetGatewaySelector selects a gateway. It correctly has a required gateway field and optional project and vpc, representing the possibility of selecting by gateway ID, in which case neither of the parent identifiers can be included.

omicron/nexus/types/src/external_api/params.rs

Lines 319 to 326 in adaa2ec

	pub struct InternetGatewaySelector {
	/// Name or ID of the project, only required if `vpc` is provided as a `Name`
	pub project: Option<NameOrId>,
	/// Name or ID of the VPC, only required if `gateway` is provided as a `Name`
	pub vpc: Option<NameOrId>,
	/// Name or ID of the internet gateway
	pub gateway: NameOrId,
	}

The endpoints

These two endpoints use InternetGatewaySelector as their query params to select a gateway. The fact that

omicron/nexus/external-api/src/lib.rs

Lines 2260 to 2274 in adaa2ec

	/// List IP pools attached to internet gateway
	#[endpoint {
	method = GET,
	path = "/v1/internet-gateway-ip-pools",
	tags = ["vpcs"],
	}]
	async fn internet_gateway_ip_pool_list(
	rqctx: RequestContext<Self::Context>,
	query_params: Query<
	PaginatedByNameOrId<params::InternetGatewaySelector>,
	>,
	) -> Result<
	HttpResponseOk<ResultsPage<views::InternetGatewayIpPool>>,
	HttpError,
	>;

omicron/nexus/external-api/src/lib.rs

Lines 2300 to 2314 in adaa2ec

	/// List IP addresses attached to internet gateway
	#[endpoint {
	method = GET,
	path = "/v1/internet-gateway-ip-addresses",
	tags = ["vpcs"],
	}]
	async fn internet_gateway_ip_address_list(
	rqctx: RequestContext<Self::Context>,
	query_params: Query<
	PaginatedByNameOrId<params::InternetGatewaySelector>,
	>,
	) -> Result<
	HttpResponseOk<ResultsPage<views::InternetGatewayIpAddress>>,
	HttpError,
	>;

The OpenAPI schema (wrong)

The gateway query param is optional, but it should not be.

omicron/openapi/nexus.json

Lines 2685 to 2694 in adaa2ec

	"operationId": "internet_gateway_ip_address_list",
	"parameters": [
	{
	"in": "query",
	"name": "gateway",
	"description": "Name or ID of the internet gateway",
	"schema": {
	"$ref": "#/components/schemas/NameOrId"
	}
	},

omicron/openapi/nexus.json

Lines 2895 to 2904 in adaa2ec

	"operationId": "internet_gateway_ip_pool_list",
	"parameters": [
	{
	"in": "query",
	"name": "gateway",
	"description": "Name or ID of the internet gateway",
	"schema": {
	"$ref": "#/components/schemas/NameOrId"
	}
	},

The TypeScript type generated accordingly

https://github.com/oxidecomputer/console/blob/653b572/app/api/__generated__/Api.ts#L4541-L4548

export interface InternetGatewayIpPoolListQueryParams {
  gateway?: NameOrId
  limit?: number
  pageToken?: string
  project?: NameOrId
  sortBy?: NameOrIdSortMode
  vpc?: NameOrId
}

What a required query param looks like

omicron/openapi/nexus.json

Lines 1824 to 1840 in adaa2ec

	"post": {
	"tags": [
	"instances"
	],
	"summary": "Create instance",
	"operationId": "instance_create",
	"parameters": [
	{
	"in": "query",
	"name": "project",
	"description": "Name or ID of the project",
	"required": true,
	"schema": {
	"$ref": "#/components/schemas/NameOrId"
	}
	}
	],

An unrelated endpoint with the same issue

This suggests it might have something to do with nesting it in the pagination thing.

omicron/nexus/external-api/src/lib.rs

Lines 1751 to 1760 in adaa2ec

	/// List network interfaces
	#[endpoint {
	method = GET,
	path = "/v1/network-interfaces",
	tags = ["instances"],
	}]
	async fn instance_network_interface_list(
	rqctx: RequestContext<Self::Context>,
	query_params: Query<PaginatedByNameOrId<params::InstanceSelector>>,
	) -> Result<HttpResponseOk<ResultsPage<InstanceNetworkInterface>>, HttpError>;