diff --git a/nexus/src/external_api/http_entrypoints.rs b/nexus/src/external_api/http_entrypoints.rs index 28755e5959..3a9e957328 100644 --- a/nexus/src/external_api/http_entrypoints.rs +++ b/nexus/src/external_api/http_entrypoints.rs @@ -411,7 +411,7 @@ async fn ping( Ok(HttpResponseOk(views::Ping { status: views::PingStatus::Ok })) } -/// Fetch the top-level IAM policy +/// Fetch top-level IAM policy #[endpoint { method = GET, path = "/v1/system/policy", @@ -430,7 +430,7 @@ async fn system_policy_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Update the top-level IAM policy +/// Update top-level IAM policy #[endpoint { method = PUT, path = "/v1/system/policy", @@ -454,7 +454,7 @@ async fn system_policy_update( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch the current silo's IAM policy +/// Fetch current silo's IAM policy #[endpoint { method = GET, path = "/v1/policy", @@ -481,7 +481,7 @@ pub(crate) async fn policy_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Update the current silo's IAM policy +/// Update current silo's IAM policy #[endpoint { method = PUT, path = "/v1/policy", @@ -513,7 +513,7 @@ async fn policy_update( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// View the resource utilization of the user's current silo +/// Fetch resource utilization for user's current silo #[endpoint { method = GET, path = "/v1/utilization", @@ -535,7 +535,7 @@ async fn utilization_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// View the current utilization of a given silo +/// Fetch current utilization for given silo #[endpoint { method = GET, path = "/v1/system/utilization/silos/{silo}", @@ -628,7 +628,7 @@ async fn system_quotas_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// View the resource quotas of a given silo +/// Fetch resource quotas for silo #[endpoint { method = GET, path = "/v1/system/silos/{silo}/quotas", @@ -651,7 +651,7 @@ async fn silo_quotas_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Update the resource quotas of a given silo +/// Update resource quotas for silo /// /// If a quota value is not specified, it will remain unchanged. #[endpoint { @@ -735,9 +735,9 @@ async fn silo_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a silo +/// Fetch silo /// -/// Fetch a silo by name or ID. +/// Fetch silo by name or ID. #[endpoint { method = GET, path = "/v1/system/silos/{silo}", @@ -829,7 +829,7 @@ async fn silo_delete( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a silo's IAM policy +/// Fetch silo IAM policy #[endpoint { method = GET, path = "/v1/system/silos/{silo}/policy", @@ -851,7 +851,7 @@ async fn silo_policy_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Update a silo's IAM policy +/// Update silo IAM policy #[endpoint { method = PUT, path = "/v1/system/silos/{silo}/policy", @@ -881,7 +881,7 @@ async fn silo_policy_update( // Silo-specific user endpoints -/// List built-in (system) users in a silo +/// List built-in (system) users in silo #[endpoint { method = GET, path = "/v1/system/users", @@ -922,7 +922,7 @@ struct UserParam { user_id: Uuid, } -/// Fetch a built-in (system) user +/// Fetch built-in (system) user #[endpoint { method = GET, path = "/v1/system/users/{user_id}", @@ -986,7 +986,7 @@ async fn silo_identity_provider_list( // Silo SAML identity providers -/// Create a SAML IdP +/// Create SAML IdP #[endpoint { method = POST, path = "/v1/system/identity-providers/saml", @@ -1015,7 +1015,7 @@ async fn saml_identity_provider_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a SAML IdP +/// Fetch SAML IdP #[endpoint { method = GET, path = "/v1/system/identity-providers/saml/{provider}", @@ -1053,7 +1053,7 @@ async fn saml_identity_provider_view( // "Local" Identity Provider -/// Create a user +/// Create user /// /// Users can only be created in Silos with `provision_type` == `Fixed`. /// Otherwise, Silo users are just-in-time (JIT) provisioned when a user first @@ -1086,7 +1086,7 @@ async fn local_idp_user_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a user +/// Delete user #[endpoint { method = DELETE, path = "/v1/system/identity-providers/local/users/{user_id}", @@ -1110,7 +1110,7 @@ async fn local_idp_user_delete( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Set or invalidate a user's password +/// Set or invalidate user's password /// /// Passwords can only be updated for users in Silos with identity mode /// `LocalOnly`. @@ -1178,7 +1178,7 @@ async fn project_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a project +/// Create project #[endpoint { method = POST, path = "/v1/projects", @@ -1199,7 +1199,7 @@ async fn project_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a project +/// Fetch project #[endpoint { method = GET, path = "/v1/projects/{project}", @@ -1223,7 +1223,7 @@ async fn project_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a project +/// Delete project #[endpoint { method = DELETE, path = "/v1/projects/{project}", @@ -1280,7 +1280,7 @@ async fn project_update( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a project's IAM policy +/// Fetch project's IAM policy #[endpoint { method = GET, path = "/v1/projects/{project}/policy", @@ -1305,7 +1305,7 @@ async fn project_policy_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Update a project's IAM policy +/// Update project's IAM policy #[endpoint { method = PUT, path = "/v1/projects/{project}/policy", @@ -1371,7 +1371,7 @@ async fn project_ip_pool_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch an IP pool +/// Fetch IP pool #[endpoint { method = GET, path = "/v1/ip-pools/{pool}", @@ -1434,7 +1434,7 @@ pub struct IpPoolPathParam { pub pool_name: Name, } -/// Create an IP pool +/// Create IP pool #[endpoint { method = POST, path = "/v1/system/ip-pools", @@ -1455,7 +1455,7 @@ async fn ip_pool_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch an IP pool +/// Fetch IP pool #[endpoint { method = GET, path = "/v1/system/ip-pools/{pool}", @@ -1479,7 +1479,7 @@ async fn ip_pool_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete an IP pool +/// Delete IP pool #[endpoint { method = DELETE, path = "/v1/system/ip-pools/{pool}", @@ -1501,7 +1501,7 @@ async fn ip_pool_delete( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Update an IP pool +/// Update IP pool #[endpoint { method = PUT, path = "/v1/system/ip-pools/{pool}", @@ -1525,7 +1525,7 @@ async fn ip_pool_update( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// List an IP pool's linked silos +/// List IP pool's linked silos #[endpoint { method = GET, path = "/v1/system/ip-pools/{pool}/silos", @@ -1573,7 +1573,7 @@ async fn ip_pool_silo_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Link an IP pool to a silo +/// Link IP pool to silo /// /// Users in linked silos can allocate external IPs from this pool for their /// instances. A silo can have at most one default pool. IPs are allocated from @@ -1603,7 +1603,7 @@ async fn ip_pool_silo_link( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Unlink an IP pool from a silo +/// Unlink IP pool from silo /// /// Will fail if there are any outstanding IPs allocated in the silo. #[endpoint { @@ -1660,7 +1660,7 @@ async fn ip_pool_silo_update( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch the Oxide service IP pool +/// Fetch Oxide service IP pool #[endpoint { method = GET, path = "/v1/system/ip-pools-service", @@ -1681,9 +1681,9 @@ async fn ip_pool_service_view( type IpPoolRangePaginationParams = PaginationParams; -/// List ranges for an IP pool +/// List ranges for IP pool /// -/// List ranges for an IP pool. Ranges are ordered by their first address. +/// Ranges are ordered by their first address. #[endpoint { method = GET, path = "/v1/system/ip-pools/{pool}/ranges", @@ -1727,7 +1727,7 @@ async fn ip_pool_range_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Add a range to an IP pool +/// Add range to IP pool #[endpoint { method = POST, path = "/v1/system/ip-pools/{pool}/ranges/add", @@ -1751,7 +1751,7 @@ async fn ip_pool_range_add( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Remove a range from an IP pool +/// Remove range from IP pool #[endpoint { method = POST, path = "/v1/system/ip-pools/{pool}/ranges/remove", @@ -1894,7 +1894,7 @@ async fn floating_ip_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a floating IP +/// Create floating IP #[endpoint { method = POST, path = "/v1/floating-ips", @@ -1920,7 +1920,7 @@ async fn floating_ip_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a floating IP +/// Delete floating IP #[endpoint { method = DELETE, path = "/v1/floating-ips/{floating_ip}", @@ -1950,7 +1950,7 @@ async fn floating_ip_delete( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a floating IP +/// Fetch floating IP #[endpoint { method = GET, path = "/v1/floating-ips/{floating_ip}", @@ -1980,7 +1980,9 @@ async fn floating_ip_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Attach a floating IP to an instance or other resource +/// Attach floating IP +/// +/// Attach floating IP to an instance or other resource. #[endpoint { method = POST, path = "/v1/floating-ips/{floating_ip}/attach", @@ -2014,7 +2016,9 @@ async fn floating_ip_attach( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Detach a floating IP from an instance or other resource +/// Detach floating IP +/// +// Detach floating IP from instance or other resource. #[endpoint { method = POST, path = "/v1/floating-ips/{floating_ip}/detach", @@ -2106,7 +2110,7 @@ async fn disk_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a disk +/// Fetch disk #[endpoint { method = GET, path = "/v1/disks/{disk}", @@ -2132,7 +2136,7 @@ async fn disk_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a disk +/// Delete disk #[endpoint { method = DELETE, path = "/v1/disks/{disk}", @@ -2220,7 +2224,7 @@ async fn disk_metrics_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Start importing blocks into a disk +/// Start importing blocks into disk /// /// Start the process of importing blocks into a disk #[endpoint { @@ -2251,7 +2255,7 @@ async fn disk_bulk_write_import_start( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Import blocks into a disk +/// Import blocks into disk #[endpoint { method = POST, path = "/v1/disks/{disk}/bulk-write", @@ -2282,7 +2286,7 @@ async fn disk_bulk_write_import( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Stop importing blocks into a disk +/// Stop importing blocks into disk /// /// Stop the process of importing blocks into a disk #[endpoint { @@ -2380,7 +2384,7 @@ async fn instance_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create an instance +/// Create instance #[endpoint { method = POST, path = "/v1/instances", @@ -2410,7 +2414,7 @@ async fn instance_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch an instance +/// Fetch instance #[endpoint { method = GET, path = "/v1/instances/{instance}", @@ -2444,7 +2448,7 @@ async fn instance_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete an instance +/// Delete instance #[endpoint { method = DELETE, path = "/v1/instances/{instance}", @@ -2540,7 +2544,7 @@ async fn instance_reboot( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Boot an instance +/// Boot instance #[endpoint { method = POST, path = "/v1/instances/{instance}/start", @@ -2569,7 +2573,7 @@ async fn instance_start( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Stop an instance +/// Stop instance #[endpoint { method = POST, path = "/v1/instances/{instance}/stop", @@ -2598,7 +2602,7 @@ async fn instance_stop( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch an instance's serial console +/// Fetch instance serial console #[endpoint { method = GET, path = "/v1/instances/{instance}/serial-console", @@ -2629,7 +2633,7 @@ async fn instance_serial_console( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Stream an instance's serial console +/// Stream instance serial console #[channel { protocol = WEBSOCKETS, path = "/v1/instances/{instance}/serial-console/stream", @@ -2681,9 +2685,10 @@ async fn instance_serial_console_stream( } } -/// List the SSH public keys added to the instance via cloud-init during instance creation +/// List SSH public keys for instance /// -/// Note that this list is a snapshot in time and will not reflect updates made after +/// List SSH public keys injected via cloud-init during instance creation. Note +/// that this list is a snapshot in time and will not reflect updates made after /// the instance is created. #[endpoint { method = GET, @@ -2725,7 +2730,7 @@ async fn instance_ssh_public_key_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// List an instance's disks +/// List disks for instance #[endpoint { method = GET, path = "/v1/instances/{instance}/disks", @@ -2766,7 +2771,7 @@ async fn instance_disk_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Attach a disk to an instance +/// Attach disk to instance #[endpoint { method = POST, path = "/v1/instances/{instance}/disks/attach", @@ -2798,7 +2803,7 @@ async fn instance_disk_attach( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Detach a disk from an instance +/// Detach disk from instance #[endpoint { method = POST, path = "/v1/instances/{instance}/disks/detach", @@ -2869,7 +2874,7 @@ async fn certificate_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a new system-wide x.509 certificate +/// Create new system-wide x.509 certificate /// /// This certificate is automatically used by the Oxide Control plane to serve /// external connections. @@ -2899,7 +2904,7 @@ struct CertificatePathParam { certificate: NameOrId, } -/// Fetch a certificate +/// Fetch certificate /// /// Returns the details of a specific certificate #[endpoint { @@ -2923,7 +2928,7 @@ async fn certificate_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a certificate +/// Delete certificate /// /// Permanently delete a certificate. This operation cannot be undone. #[endpoint { @@ -2951,7 +2956,7 @@ async fn certificate_delete( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create an address lot +/// Create address lot #[endpoint { method = POST, path = "/v1/system/networking/address-lot", @@ -2977,7 +2982,7 @@ async fn networking_address_lot_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete an address lot +/// Delete address lot #[endpoint { method = DELETE, path = "/v1/system/networking/address-lot/{address_lot}", @@ -3034,7 +3039,7 @@ async fn networking_address_lot_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// List the blocks in an address lot +/// List blocks in address lot #[endpoint { method = GET, path = "/v1/system/networking/address-lot/{address_lot}/blocks", @@ -3070,7 +3075,7 @@ async fn networking_address_lot_block_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a loopback address +/// Create loopback address #[endpoint { method = POST, path = "/v1/system/networking/loopback-address", @@ -3111,7 +3116,7 @@ pub struct LoopbackAddressPath { pub subnet_mask: u8, } -/// Delete a loopback address +/// Delete loopback address #[endpoint { method = DELETE, path = "/v1/system/networking/loopback-address/{rack_id}/{switch_location}/{address}/{subnet_mask}", @@ -3258,7 +3263,7 @@ async fn networking_switch_port_settings_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Get information about a switch port +/// Get information about switch port #[endpoint { method = GET, path = "/v1/system/networking/switch-port-settings/{port}", @@ -3361,7 +3366,7 @@ async fn networking_switch_port_clear_settings( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a new BGP configuration +/// Create new BGP configuration #[endpoint { method = POST, path = "/v1/system/networking/bgp", @@ -3458,7 +3463,7 @@ async fn networking_bgp_imported_routes_ipv4( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a BGP configuration +/// Delete BGP configuration #[endpoint { method = DELETE, path = "/v1/system/networking/bgp", @@ -3479,7 +3484,7 @@ async fn networking_bgp_config_delete( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a new BGP announce set +/// Create new BGP announce set #[endpoint { method = POST, path = "/v1/system/networking/bgp-announce", @@ -3527,7 +3532,7 @@ async fn networking_bgp_announce_set_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a BGP announce set +/// Delete BGP announce set #[endpoint { method = DELETE, path = "/v1/system/networking/bgp-announce", @@ -3661,7 +3666,7 @@ async fn image_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create an image +/// Create image /// /// Create a new image in a project. #[endpoint { @@ -3699,7 +3704,7 @@ async fn image_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch an image +/// Fetch image /// /// Fetch the details for a specific image in a project. #[endpoint { @@ -3742,7 +3747,7 @@ async fn image_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete an image +/// Delete image /// /// Permanently delete an image from a project. This operation cannot be undone. /// Any instances in the project using the image will continue to run, however @@ -3778,9 +3783,9 @@ async fn image_delete( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Promote a project image +/// Promote project image /// -/// Promote a project image to be visible to all projects in the silo +/// Promote project image to be visible to all projects in the silo #[endpoint { method = POST, path = "/v1/images/{image}/promote", @@ -3812,9 +3817,9 @@ async fn image_promote( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Demote a silo image +/// Demote silo image /// -/// Demote a silo image to be visible only to a specified project +/// Demote silo image to be visible only to a specified project #[endpoint { method = POST, path = "/v1/images/{image}/demote", @@ -3886,7 +3891,7 @@ async fn instance_network_interface_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a network interface +/// Create network interface #[endpoint { method = POST, path = "/v1/network-interfaces", @@ -3915,7 +3920,7 @@ async fn instance_network_interface_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a network interface +/// Delete network interface /// /// Note that the primary interface for an instance cannot be deleted if there /// are any secondary interfaces. A new primary interface must be designated @@ -3952,7 +3957,7 @@ async fn instance_network_interface_delete( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a network interface +/// Fetch network interface #[endpoint { method = GET, path = "/v1/network-interfaces/{interface}", @@ -3983,7 +3988,7 @@ async fn instance_network_interface_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Update a network interface +/// Update network interface #[endpoint { method = PUT, path = "/v1/network-interfaces/{interface}", @@ -4057,7 +4062,7 @@ async fn instance_external_ip_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Allocate and attach an ephemeral IP to an instance +/// Allocate and attach ephemeral IP to instance #[endpoint { method = POST, path = "/v1/instances/{instance}/external-ips/ephemeral", @@ -4095,7 +4100,7 @@ async fn instance_ephemeral_ip_attach( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Detach and deallocate an ephemeral IP from an instance +/// Detach and deallocate ephemeral IP from instance #[endpoint { method = DELETE, path = "/v1/instances/{instance}/external-ips/ephemeral", @@ -4167,7 +4172,7 @@ async fn snapshot_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a snapshot +/// Create snapshot /// /// Creates a point-in-time snapshot from a disk. #[endpoint { @@ -4195,7 +4200,7 @@ async fn snapshot_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a snapshot +/// Fetch snapshot #[endpoint { method = GET, path = "/v1/snapshots/{snapshot}", @@ -4223,7 +4228,7 @@ async fn snapshot_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a snapshot +/// Delete snapshot #[endpoint { method = DELETE, path = "/v1/snapshots/{snapshot}", @@ -4290,7 +4295,7 @@ async fn vpc_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a VPC +/// Create VPC #[endpoint { method = POST, path = "/v1/vpcs", @@ -4316,7 +4321,7 @@ async fn vpc_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a VPC +/// Fetch VPC #[endpoint { method = GET, path = "/v1/vpcs/{vpc}", @@ -4371,7 +4376,7 @@ async fn vpc_update( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a VPC +/// Delete VPC #[endpoint { method = DELETE, path = "/v1/vpcs/{vpc}", @@ -4432,7 +4437,7 @@ async fn vpc_subnet_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a subnet +/// Create subnet #[endpoint { method = POST, path = "/v1/vpc-subnets", @@ -4457,7 +4462,7 @@ async fn vpc_subnet_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a subnet +/// Fetch subnet #[endpoint { method = GET, path = "/v1/vpc-subnets/{subnet}", @@ -4486,7 +4491,7 @@ async fn vpc_subnet_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a subnet +/// Delete subnet #[endpoint { method = DELETE, path = "/v1/vpc-subnets/{subnet}", @@ -4515,7 +4520,7 @@ async fn vpc_subnet_delete( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Update a subnet +/// Update subnet #[endpoint { method = PUT, path = "/v1/vpc-subnets/{subnet}", @@ -4695,7 +4700,7 @@ async fn vpc_router_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a router +/// Fetch router #[endpoint { method = GET, path = "/v1/vpc-routers/{router}", @@ -4725,7 +4730,7 @@ async fn vpc_router_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a VPC router +/// Create VPC router #[endpoint { method = POST, path = "/v1/vpc-routers", @@ -4757,7 +4762,7 @@ async fn vpc_router_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a router +/// Delete router #[endpoint { method = DELETE, path = "/v1/vpc-routers/{router}", @@ -4787,7 +4792,7 @@ async fn vpc_router_delete( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Update a router +/// Update router #[endpoint { method = PUT, path = "/v1/vpc-routers/{router}", @@ -4861,7 +4866,7 @@ async fn vpc_router_route_list( // Vpc Router Routes -/// Fetch a route +/// Fetch route #[endpoint { method = GET, path = "/v1/vpc-router-routes/{route}", @@ -4894,7 +4899,7 @@ async fn vpc_router_route_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create a router +/// Create router #[endpoint { method = POST, path = "/v1/vpc-router-routes", @@ -4926,7 +4931,7 @@ async fn vpc_router_route_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete a route +/// Delete route #[endpoint { method = DELETE, path = "/v1/vpc-router-routes/{route}", @@ -4958,7 +4963,7 @@ async fn vpc_router_route_delete( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Update a route +/// Update route #[endpoint { method = PUT, path = "/v1/vpc-router-routes/{route}", @@ -5033,7 +5038,7 @@ struct RackPathParam { rack_id: Uuid, } -/// Fetch a rack +/// Fetch rack #[endpoint { method = GET, path = "/v1/system/hardware/racks/{rack_id}", @@ -5054,7 +5059,7 @@ async fn rack_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// List uninitialized sleds in a given rack +/// List uninitialized sleds #[endpoint { method = GET, path = "/v1/system/hardware/sleds-uninitialized", @@ -5081,7 +5086,7 @@ async fn sled_list_uninitialized( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Add a sled to an initialized rack +/// Add sled to initialized rack // // TODO: In the future this should really be a PUT request, once we resolve // https://github.com/oxidecomputer/omicron/issues/4494. It should also @@ -5138,7 +5143,7 @@ async fn sled_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a sled +/// Fetch sled #[endpoint { method = GET, path = "/v1/system/hardware/sleds/{sled_id}", @@ -5160,7 +5165,7 @@ async fn sled_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Set the sled's provision state +/// Set sled provision state #[endpoint { method = PUT, path = "/v1/system/hardware/sleds/{sled_id}/provision-state", @@ -5198,7 +5203,7 @@ async fn sled_set_provision_state( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// List instances running on a given sled +/// List instances running on given sled #[endpoint { method = GET, path = "/v1/system/hardware/sleds/{sled_id}/instances", @@ -5299,7 +5304,7 @@ async fn switch_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a switch +/// Fetch switch #[endpoint { method = GET, path = "/v1/system/hardware/switches/{switch_id}", @@ -5482,7 +5487,7 @@ async fn silo_metric( // Updates -/// Upload a TUF repository +/// Upload TUF repository #[endpoint { method = PUT, path = "/v1/system/update/repository", @@ -5507,7 +5512,9 @@ async fn system_update_put_repository( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Get the description of a repository by system version. +/// Fetch TUF repository description +/// +/// Fetch description of TUF repository by system version. #[endpoint { method = GET, path = "/v1/system/update/repository/{system_version}", @@ -5662,7 +5669,7 @@ async fn user_builtin_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a built-in user +/// Fetch built-in user #[endpoint { method = GET, path = "/v1/system/users-builtin/{user}", @@ -5744,7 +5751,7 @@ async fn role_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch a built-in role +/// Fetch built-in role #[endpoint { method = GET, path = "/v1/system/roles/{role_name}", @@ -5768,7 +5775,7 @@ async fn role_view( // Current user -/// Fetch the user associated with the current session +/// Fetch user for current session #[endpoint { method = GET, path = "/v1/me", @@ -5791,7 +5798,7 @@ pub(crate) async fn current_user_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch the silo groups the current user belongs to +/// Fetch current user's groups #[endpoint { method = GET, path = "/v1/me/groups", @@ -5865,7 +5872,7 @@ async fn current_user_ssh_key_list( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Create an SSH public key +/// Create SSH public key /// /// Create an SSH public key for the currently authenticated user. #[endpoint { @@ -5893,9 +5900,9 @@ async fn current_user_ssh_key_create( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Fetch an SSH public key +/// Fetch SSH public key /// -/// Fetch an SSH public key associated with the currently authenticated user. +/// Fetch SSH public key associated with the currently authenticated user. #[endpoint { method = GET, path = "/v1/me/ssh-keys/{ssh_key}", @@ -5927,7 +5934,7 @@ async fn current_user_ssh_key_view( apictx.external_latencies.instrument_dropshot_handler(&rqctx, handler).await } -/// Delete an SSH public key +/// Delete SSH public key /// /// Delete an SSH public key associated with the currently authenticated user. #[endpoint { diff --git a/openapi/nexus.json b/openapi/nexus.json index 8baf1a6316..d27261b179 100644 --- a/openapi/nexus.json +++ b/openapi/nexus.json @@ -223,7 +223,7 @@ "tags": [ "silos" ], - "summary": "Create a new system-wide x.509 certificate", + "summary": "Create new system-wide x.509 certificate", "description": "This certificate is automatically used by the Oxide Control plane to serve external connections.", "operationId": "certificate_create", "requestBody": { @@ -261,7 +261,7 @@ "tags": [ "silos" ], - "summary": "Fetch a certificate", + "summary": "Fetch certificate", "description": "Returns the details of a specific certificate", "operationId": "certificate_view", "parameters": [ @@ -297,7 +297,7 @@ "tags": [ "silos" ], - "summary": "Delete a certificate", + "summary": "Delete certificate", "description": "Permanently delete a certificate. This operation cannot be undone.", "operationId": "certificate_delete", "parameters": [ @@ -443,7 +443,7 @@ "tags": [ "disks" ], - "summary": "Fetch a disk", + "summary": "Fetch disk", "operationId": "disk_view", "parameters": [ { @@ -487,7 +487,7 @@ "tags": [ "disks" ], - "summary": "Delete a disk", + "summary": "Delete disk", "operationId": "disk_delete", "parameters": [ { @@ -526,7 +526,7 @@ "tags": [ "disks" ], - "summary": "Import blocks into a disk", + "summary": "Import blocks into disk", "operationId": "disk_bulk_write_import", "parameters": [ { @@ -575,7 +575,7 @@ "tags": [ "disks" ], - "summary": "Start importing blocks into a disk", + "summary": "Start importing blocks into disk", "description": "Start the process of importing blocks into a disk", "operationId": "disk_bulk_write_import_start", "parameters": [ @@ -615,7 +615,7 @@ "tags": [ "disks" ], - "summary": "Stop importing blocks into a disk", + "summary": "Stop importing blocks into disk", "description": "Stop the process of importing blocks into a disk", "operationId": "disk_bulk_write_import_stop", "parameters": [ @@ -876,7 +876,7 @@ "tags": [ "floating-ips" ], - "summary": "Create a floating IP", + "summary": "Create floating IP", "operationId": "floating_ip_create", "parameters": [ { @@ -924,7 +924,7 @@ "tags": [ "floating-ips" ], - "summary": "Fetch a floating IP", + "summary": "Fetch floating IP", "operationId": "floating_ip_view", "parameters": [ { @@ -968,7 +968,7 @@ "tags": [ "floating-ips" ], - "summary": "Delete a floating IP", + "summary": "Delete floating IP", "operationId": "floating_ip_delete", "parameters": [ { @@ -1007,7 +1007,8 @@ "tags": [ "floating-ips" ], - "summary": "Attach a floating IP to an instance or other resource", + "summary": "Attach floating IP", + "description": "Attach floating IP to an instance or other resource.", "operationId": "floating_ip_attach", "parameters": [ { @@ -1063,7 +1064,7 @@ "tags": [ "floating-ips" ], - "summary": "Detach a floating IP from an instance or other resource", + "summary": "Detach floating IP", "operationId": "floating_ip_detach", "parameters": [ { @@ -1273,7 +1274,7 @@ "tags": [ "images" ], - "summary": "Create an image", + "summary": "Create image", "description": "Create a new image in a project.", "operationId": "image_create", "parameters": [ @@ -1321,7 +1322,7 @@ "tags": [ "images" ], - "summary": "Fetch an image", + "summary": "Fetch image", "description": "Fetch the details for a specific image in a project.", "operationId": "image_view", "parameters": [ @@ -1366,7 +1367,7 @@ "tags": [ "images" ], - "summary": "Delete an image", + "summary": "Delete image", "description": "Permanently delete an image from a project. This operation cannot be undone. Any instances in the project using the image will continue to run, however new instances can not be created with this image.", "operationId": "image_delete", "parameters": [ @@ -1406,8 +1407,8 @@ "tags": [ "images" ], - "summary": "Demote a silo image", - "description": "Demote a silo image to be visible only to a specified project", + "summary": "Demote silo image", + "description": "Demote silo image to be visible only to a specified project", "operationId": "image_demote", "parameters": [ { @@ -1454,8 +1455,8 @@ "tags": [ "images" ], - "summary": "Promote a project image", - "description": "Promote a project image to be visible to all projects in the silo", + "summary": "Promote project image", + "description": "Promote project image to be visible to all projects in the silo", "operationId": "image_promote", "parameters": [ { @@ -1568,7 +1569,7 @@ "tags": [ "instances" ], - "summary": "Create an instance", + "summary": "Create instance", "operationId": "instance_create", "parameters": [ { @@ -1616,7 +1617,7 @@ "tags": [ "instances" ], - "summary": "Fetch an instance", + "summary": "Fetch instance", "operationId": "instance_view", "parameters": [ { @@ -1660,7 +1661,7 @@ "tags": [ "instances" ], - "summary": "Delete an instance", + "summary": "Delete instance", "operationId": "instance_delete", "parameters": [ { @@ -1699,7 +1700,7 @@ "tags": [ "instances" ], - "summary": "List an instance's disks", + "summary": "List disks for instance", "operationId": "instance_disk_list", "parameters": [ { @@ -1775,7 +1776,7 @@ "tags": [ "instances" ], - "summary": "Attach a disk to an instance", + "summary": "Attach disk to instance", "operationId": "instance_disk_attach", "parameters": [ { @@ -1831,7 +1832,7 @@ "tags": [ "instances" ], - "summary": "Detach a disk from an instance", + "summary": "Detach disk from instance", "operationId": "instance_disk_detach", "parameters": [ { @@ -1933,7 +1934,7 @@ "tags": [ "instances" ], - "summary": "Allocate and attach an ephemeral IP to an instance", + "summary": "Allocate and attach ephemeral IP to instance", "operationId": "instance_ephemeral_ip_attach", "parameters": [ { @@ -1987,7 +1988,7 @@ "tags": [ "instances" ], - "summary": "Detach and deallocate an ephemeral IP from an instance", + "summary": "Detach and deallocate ephemeral IP from instance", "operationId": "instance_ephemeral_ip_detach", "parameters": [ { @@ -2128,7 +2129,7 @@ "tags": [ "instances" ], - "summary": "Fetch an instance's serial console", + "summary": "Fetch instance serial console", "operationId": "instance_serial_console", "parameters": [ { @@ -2207,7 +2208,7 @@ "tags": [ "instances" ], - "summary": "Stream an instance's serial console", + "summary": "Stream instance serial console", "operationId": "instance_serial_console_stream", "parameters": [ { @@ -2257,8 +2258,8 @@ "tags": [ "instances" ], - "summary": "List the SSH public keys added to the instance via cloud-init during instance creation", - "description": "Note that this list is a snapshot in time and will not reflect updates made after the instance is created.", + "summary": "List SSH public keys for instance", + "description": "List SSH public keys injected via cloud-init during instance creation. Note that this list is a snapshot in time and will not reflect updates made after the instance is created.", "operationId": "instance_ssh_public_key_list", "parameters": [ { @@ -2334,7 +2335,7 @@ "tags": [ "instances" ], - "summary": "Boot an instance", + "summary": "Boot instance", "operationId": "instance_start", "parameters": [ { @@ -2380,7 +2381,7 @@ "tags": [ "instances" ], - "summary": "Stop an instance", + "summary": "Stop instance", "operationId": "instance_stop", "parameters": [ { @@ -2485,7 +2486,7 @@ "tags": [ "projects" ], - "summary": "Fetch an IP pool", + "summary": "Fetch IP pool", "operationId": "project_ip_pool_view", "parameters": [ { @@ -2583,7 +2584,7 @@ "tags": [ "session" ], - "summary": "Fetch the user associated with the current session", + "summary": "Fetch user for current session", "operationId": "current_user_view", "responses": { "200": { @@ -2610,7 +2611,7 @@ "tags": [ "session" ], - "summary": "Fetch the silo groups the current user belongs to", + "summary": "Fetch current user's groups", "operationId": "current_user_groups", "parameters": [ { @@ -2727,7 +2728,7 @@ "tags": [ "session" ], - "summary": "Create an SSH public key", + "summary": "Create SSH public key", "description": "Create an SSH public key for the currently authenticated user.", "operationId": "current_user_ssh_key_create", "requestBody": { @@ -2765,8 +2766,8 @@ "tags": [ "session" ], - "summary": "Fetch an SSH public key", - "description": "Fetch an SSH public key associated with the currently authenticated user.", + "summary": "Fetch SSH public key", + "description": "Fetch SSH public key associated with the currently authenticated user.", "operationId": "current_user_ssh_key_view", "parameters": [ { @@ -2802,7 +2803,7 @@ "tags": [ "session" ], - "summary": "Delete an SSH public key", + "summary": "Delete SSH public key", "description": "Delete an SSH public key associated with the currently authenticated user.", "operationId": "current_user_ssh_key_delete", "parameters": [ @@ -3006,7 +3007,7 @@ "tags": [ "instances" ], - "summary": "Create a network interface", + "summary": "Create network interface", "operationId": "instance_network_interface_create", "parameters": [ { @@ -3062,7 +3063,7 @@ "tags": [ "instances" ], - "summary": "Fetch a network interface", + "summary": "Fetch network interface", "operationId": "instance_network_interface_view", "parameters": [ { @@ -3114,7 +3115,7 @@ "tags": [ "instances" ], - "summary": "Update a network interface", + "summary": "Update network interface", "operationId": "instance_network_interface_update", "parameters": [ { @@ -3176,7 +3177,7 @@ "tags": [ "instances" ], - "summary": "Delete a network interface", + "summary": "Delete network interface", "description": "Note that the primary interface for an instance cannot be deleted if there are any secondary interfaces. A new primary interface must be designated first. The primary interface can be deleted if there are no secondary interfaces.", "operationId": "instance_network_interface_delete", "parameters": [ @@ -3252,7 +3253,7 @@ "tags": [ "silos" ], - "summary": "Fetch the current silo's IAM policy", + "summary": "Fetch current silo's IAM policy", "operationId": "policy_view", "responses": { "200": { @@ -3277,7 +3278,7 @@ "tags": [ "silos" ], - "summary": "Update the current silo's IAM policy", + "summary": "Update current silo's IAM policy", "operationId": "policy_update", "requestBody": { "content": { @@ -3371,7 +3372,7 @@ "tags": [ "projects" ], - "summary": "Create a project", + "summary": "Create project", "operationId": "project_create", "requestBody": { "content": { @@ -3408,7 +3409,7 @@ "tags": [ "projects" ], - "summary": "Fetch a project", + "summary": "Fetch project", "operationId": "project_view", "parameters": [ { @@ -3490,7 +3491,7 @@ "tags": [ "projects" ], - "summary": "Delete a project", + "summary": "Delete project", "operationId": "project_delete", "parameters": [ { @@ -3521,7 +3522,7 @@ "tags": [ "projects" ], - "summary": "Fetch a project's IAM policy", + "summary": "Fetch project's IAM policy", "operationId": "project_policy_view", "parameters": [ { @@ -3557,7 +3558,7 @@ "tags": [ "projects" ], - "summary": "Update a project's IAM policy", + "summary": "Update project's IAM policy", "operationId": "project_policy_update", "parameters": [ { @@ -3672,7 +3673,7 @@ "tags": [ "snapshots" ], - "summary": "Create a snapshot", + "summary": "Create snapshot", "description": "Creates a point-in-time snapshot from a disk.", "operationId": "snapshot_create", "parameters": [ @@ -3721,7 +3722,7 @@ "tags": [ "snapshots" ], - "summary": "Fetch a snapshot", + "summary": "Fetch snapshot", "operationId": "snapshot_view", "parameters": [ { @@ -3765,7 +3766,7 @@ "tags": [ "snapshots" ], - "summary": "Delete a snapshot", + "summary": "Delete snapshot", "operationId": "snapshot_delete", "parameters": [ { @@ -3922,7 +3923,7 @@ "tags": [ "system/hardware" ], - "summary": "Fetch a rack", + "summary": "Fetch rack", "operationId": "rack_view", "parameters": [ { @@ -4018,7 +4019,7 @@ "tags": [ "system/hardware" ], - "summary": "Add a sled to an initialized rack", + "summary": "Add sled to initialized rack", "operationId": "sled_add", "requestBody": { "content": { @@ -4048,7 +4049,7 @@ "tags": [ "system/hardware" ], - "summary": "Fetch a sled", + "summary": "Fetch sled", "operationId": "sled_view", "parameters": [ { @@ -4156,7 +4157,7 @@ "tags": [ "system/hardware" ], - "summary": "List instances running on a given sled", + "summary": "List instances running on given sled", "operationId": "sled_instance_list", "parameters": [ { @@ -4225,7 +4226,7 @@ "tags": [ "system/hardware" ], - "summary": "Set the sled's provision state", + "summary": "Set sled provision state", "operationId": "sled_set_provision_state", "parameters": [ { @@ -4274,7 +4275,7 @@ "tags": [ "system/hardware" ], - "summary": "List uninitialized sleds in a given rack", + "summary": "List uninitialized sleds", "operationId": "sled_list_uninitialized", "parameters": [ { @@ -4562,7 +4563,7 @@ "tags": [ "system/hardware" ], - "summary": "Fetch a switch", + "summary": "Fetch switch", "operationId": "switch_view", "parameters": [ { @@ -4670,7 +4671,7 @@ "tags": [ "system/silos" ], - "summary": "Create a user", + "summary": "Create user", "description": "Users can only be created in Silos with `provision_type` == `Fixed`. Otherwise, Silo users are just-in-time (JIT) provisioned when a user first logs in using an external Identity Provider.", "operationId": "local_idp_user_create", "parameters": [ @@ -4719,7 +4720,7 @@ "tags": [ "system/silos" ], - "summary": "Delete a user", + "summary": "Delete user", "operationId": "local_idp_user_delete", "parameters": [ { @@ -4760,7 +4761,7 @@ "tags": [ "system/silos" ], - "summary": "Set or invalidate a user's password", + "summary": "Set or invalidate user's password", "description": "Passwords can only be updated for users in Silos with identity mode `LocalOnly`.", "operationId": "local_idp_user_set_password", "parameters": [ @@ -4812,7 +4813,7 @@ "tags": [ "system/silos" ], - "summary": "Create a SAML IdP", + "summary": "Create SAML IdP", "operationId": "saml_identity_provider_create", "parameters": [ { @@ -4860,7 +4861,7 @@ "tags": [ "system/silos" ], - "summary": "Fetch a SAML IdP", + "summary": "Fetch SAML IdP", "operationId": "saml_identity_provider_view", "parameters": [ { @@ -4964,7 +4965,7 @@ "tags": [ "system/networking" ], - "summary": "Create an IP pool", + "summary": "Create IP pool", "operationId": "ip_pool_create", "requestBody": { "content": { @@ -5001,7 +5002,7 @@ "tags": [ "system/networking" ], - "summary": "Fetch an IP pool", + "summary": "Fetch IP pool", "operationId": "ip_pool_view", "parameters": [ { @@ -5037,7 +5038,7 @@ "tags": [ "system/networking" ], - "summary": "Update an IP pool", + "summary": "Update IP pool", "operationId": "ip_pool_update", "parameters": [ { @@ -5083,7 +5084,7 @@ "tags": [ "system/networking" ], - "summary": "Delete an IP pool", + "summary": "Delete IP pool", "operationId": "ip_pool_delete", "parameters": [ { @@ -5114,8 +5115,8 @@ "tags": [ "system/networking" ], - "summary": "List ranges for an IP pool", - "description": "List ranges for an IP pool. Ranges are ordered by their first address.", + "summary": "List ranges for IP pool", + "description": "Ranges are ordered by their first address.", "operationId": "ip_pool_range_list", "parameters": [ { @@ -5176,7 +5177,7 @@ "tags": [ "system/networking" ], - "summary": "Add a range to an IP pool", + "summary": "Add range to IP pool", "operationId": "ip_pool_range_add", "parameters": [ { @@ -5224,7 +5225,7 @@ "tags": [ "system/networking" ], - "summary": "Remove a range from an IP pool", + "summary": "Remove range from IP pool", "operationId": "ip_pool_range_remove", "parameters": [ { @@ -5265,7 +5266,7 @@ "tags": [ "system/networking" ], - "summary": "List an IP pool's linked silos", + "summary": "List IP pool's linked silos", "operationId": "ip_pool_silo_list", "parameters": [ { @@ -5331,7 +5332,7 @@ "tags": [ "system/networking" ], - "summary": "Link an IP pool to a silo", + "summary": "Link IP pool to silo", "description": "Users in linked silos can allocate external IPs from this pool for their instances. A silo can have at most one default pool. IPs are allocated from the default pool when users ask for one without specifying a pool.", "operationId": "ip_pool_silo_link", "parameters": [ @@ -5434,7 +5435,7 @@ "tags": [ "system/networking" ], - "summary": "Unlink an IP pool from a silo", + "summary": "Unlink IP pool from silo", "description": "Will fail if there are any outstanding IPs allocated in the silo.", "operationId": "ip_pool_silo_unlink", "parameters": [ @@ -5473,7 +5474,7 @@ "tags": [ "system/networking" ], - "summary": "Fetch the Oxide service IP pool", + "summary": "Fetch Oxide service IP pool", "operationId": "ip_pool_service_view", "responses": { "200": { @@ -5774,7 +5775,7 @@ "tags": [ "system/networking" ], - "summary": "Create an address lot", + "summary": "Create address lot", "operationId": "networking_address_lot_create", "requestBody": { "content": { @@ -5811,7 +5812,7 @@ "tags": [ "system/networking" ], - "summary": "Delete an address lot", + "summary": "Delete address lot", "operationId": "networking_address_lot_delete", "parameters": [ { @@ -5842,7 +5843,7 @@ "tags": [ "system/networking" ], - "summary": "List the blocks in an address lot", + "summary": "List blocks in address lot", "operationId": "networking_address_lot_block_list", "parameters": [ { @@ -6066,7 +6067,7 @@ "tags": [ "system/networking" ], - "summary": "Create a new BGP configuration", + "summary": "Create new BGP configuration", "operationId": "networking_bgp_config_create", "requestBody": { "content": { @@ -6101,7 +6102,7 @@ "tags": [ "system/networking" ], - "summary": "Delete a BGP configuration", + "summary": "Delete BGP configuration", "operationId": "networking_bgp_config_delete", "parameters": [ { @@ -6172,7 +6173,7 @@ "tags": [ "system/networking" ], - "summary": "Create a new BGP announce set", + "summary": "Create new BGP announce set", "operationId": "networking_bgp_announce_set_create", "requestBody": { "content": { @@ -6207,7 +6208,7 @@ "tags": [ "system/networking" ], - "summary": "Delete a BGP announce set", + "summary": "Delete BGP announce set", "operationId": "networking_bgp_announce_set_delete", "parameters": [ { @@ -6370,7 +6371,7 @@ "tags": [ "system/networking" ], - "summary": "Create a loopback address", + "summary": "Create loopback address", "operationId": "networking_loopback_address_create", "requestBody": { "content": { @@ -6407,7 +6408,7 @@ "tags": [ "system/networking" ], - "summary": "Delete a loopback address", + "summary": "Delete loopback address", "operationId": "networking_loopback_address_delete", "parameters": [ { @@ -6599,7 +6600,7 @@ "tags": [ "system/networking" ], - "summary": "Get information about a switch port", + "summary": "Get information about switch port", "operationId": "networking_switch_port_settings_view", "parameters": [ { @@ -6637,7 +6638,7 @@ "tags": [ "policy" ], - "summary": "Fetch the top-level IAM policy", + "summary": "Fetch top-level IAM policy", "operationId": "system_policy_view", "responses": { "200": { @@ -6662,7 +6663,7 @@ "tags": [ "policy" ], - "summary": "Update the top-level IAM policy", + "summary": "Update top-level IAM policy", "operationId": "system_policy_update", "requestBody": { "content": { @@ -6751,7 +6752,7 @@ "tags": [ "roles" ], - "summary": "Fetch a built-in role", + "summary": "Fetch built-in role", "operationId": "role_view", "parameters": [ { @@ -6943,8 +6944,8 @@ "tags": [ "system/silos" ], - "summary": "Fetch a silo", - "description": "Fetch a silo by name or ID.", + "summary": "Fetch silo", + "description": "Fetch silo by name or ID.", "operationId": "silo_view", "parameters": [ { @@ -7081,7 +7082,7 @@ "tags": [ "system/silos" ], - "summary": "Fetch a silo's IAM policy", + "summary": "Fetch silo IAM policy", "operationId": "silo_policy_view", "parameters": [ { @@ -7117,7 +7118,7 @@ "tags": [ "system/silos" ], - "summary": "Update a silo's IAM policy", + "summary": "Update silo IAM policy", "operationId": "silo_policy_update", "parameters": [ { @@ -7165,7 +7166,7 @@ "tags": [ "system/silos" ], - "summary": "View the resource quotas of a given silo", + "summary": "Fetch resource quotas for silo", "operationId": "silo_quotas_view", "parameters": [ { @@ -7201,7 +7202,7 @@ "tags": [ "system/silos" ], - "summary": "Update the resource quotas of a given silo", + "summary": "Update resource quotas for silo", "description": "If a quota value is not specified, it will remain unchanged.", "operationId": "silo_quotas_update", "parameters": [ @@ -7250,7 +7251,7 @@ "tags": [ "system/silos" ], - "summary": "List built-in (system) users in a silo", + "summary": "List built-in (system) users in silo", "operationId": "silo_user_list", "parameters": [ { @@ -7319,7 +7320,7 @@ "tags": [ "system/silos" ], - "summary": "Fetch a built-in (system) user", + "summary": "Fetch built-in (system) user", "operationId": "silo_user_view", "parameters": [ { @@ -7426,7 +7427,7 @@ "tags": [ "system/silos" ], - "summary": "Fetch a built-in user", + "summary": "Fetch built-in user", "operationId": "user_builtin_view", "parameters": [ { @@ -7522,7 +7523,7 @@ "tags": [ "system/silos" ], - "summary": "View the current utilization of a given silo", + "summary": "Fetch current utilization for given silo", "operationId": "silo_utilization_view", "parameters": [ { @@ -7628,7 +7629,7 @@ "tags": [ "silos" ], - "summary": "View the resource utilization of the user's current silo", + "summary": "Fetch resource utilization for user's current silo", "operationId": "utilization_view", "responses": { "200": { @@ -7830,7 +7831,7 @@ "tags": [ "vpcs" ], - "summary": "Create a subnet", + "summary": "Create subnet", "operationId": "vpc_subnet_create", "parameters": [ { @@ -7886,7 +7887,7 @@ "tags": [ "vpcs" ], - "summary": "Fetch a subnet", + "summary": "Fetch subnet", "operationId": "vpc_subnet_view", "parameters": [ { @@ -7938,7 +7939,7 @@ "tags": [ "vpcs" ], - "summary": "Update a subnet", + "summary": "Update subnet", "operationId": "vpc_subnet_update", "parameters": [ { @@ -8000,7 +8001,7 @@ "tags": [ "vpcs" ], - "summary": "Delete a subnet", + "summary": "Delete subnet", "operationId": "vpc_subnet_delete", "parameters": [ { @@ -8198,7 +8199,7 @@ "tags": [ "vpcs" ], - "summary": "Create a VPC", + "summary": "Create VPC", "operationId": "vpc_create", "parameters": [ { @@ -8246,7 +8247,7 @@ "tags": [ "vpcs" ], - "summary": "Fetch a VPC", + "summary": "Fetch VPC", "operationId": "vpc_view", "parameters": [ { @@ -8344,7 +8345,7 @@ "tags": [ "vpcs" ], - "summary": "Delete a VPC", + "summary": "Delete VPC", "operationId": "vpc_delete", "parameters": [ {