Skip to content

Commit 2e3a662

Browse files
ahlahl
authored
improvements to the external interface (#8274)
- remove the "hidden" tag and split into more explicit tags - export tuf/upgrade related entrypoints - clean up docs inappropriate for the public docs
1 parent 21baa14 commit 2e3a662

File tree

14 files changed

+428
-158
lines changed

14 files changed

+428
-158
lines changed

‎common/src/update/artifact_id.rs

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,9 @@ use serde::{Deserialize, Serialize};
1010
use tufaceous_artifact::{Artifact, ArtifactKind, ArtifactVersion};
1111

1212
/// An identifier for an artifact.
13-
///
14-
/// The kind is [`ArtifactKind`], indicating that it might represent an artifact
15-
/// whose kind is unknown.
13+
//
14+
// The kind is [`ArtifactKind`], indicating that it might represent an artifact
15+
// whose kind is unknown.
1616
// TODO: move this to tufaceous-artifact in the future
1717
#[derive(
1818
Debug,
@@ -32,6 +32,7 @@ pub struct ArtifactId {
3232
pub name: String,
3333

3434
/// The artifact's version.
35+
#[schemars(with = "String")]
3536
pub version: ArtifactVersion,
3637

3738
/// The kind of artifact this is.

‎dev-tools/omicron-dev/tests/test-omicron-dev.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ use omicron_test_utils::dev::test_cmds::EXIT_USAGE;
1414
use omicron_test_utils::dev::test_cmds::assert_exit_code;
1515
use omicron_test_utils::dev::test_cmds::path_to_executable;
1616
use omicron_test_utils::dev::test_cmds::run_command;
17-
use oxide_client::ClientHiddenExt;
17+
use oxide_client::ClientConsoleAuthExt;
1818
use std::io::BufRead;
1919
use std::path::PathBuf;
2020
use subprocess::Exec;

‎end-to-end-tests/src/bin/bootstrap.rs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ use oxide_client::types::{
88
NameOrId, SiloQuotasUpdate,
99
};
1010
use oxide_client::{
11-
ClientDisksExt, ClientHiddenExt, ClientProjectsExt, ClientSystemIpPoolsExt,
12-
ClientSystemSilosExt,
11+
ClientConsoleAuthExt, ClientDisksExt, ClientProjectsExt,
12+
ClientSystemIpPoolsExt, ClientSystemSilosExt,
1313
};
1414
use serde::{Deserialize, de::DeserializeOwned};
1515
use std::time::Duration;

‎end-to-end-tests/src/bin/commtest.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ use clap::{Parser, Subcommand};
33
use end_to_end_tests::helpers::cli::oxide_cli_style;
44
use end_to_end_tests::helpers::icmp::ping4_test_run;
55
use oxide_client::{
6-
ClientHiddenExt, ClientLoginExt, ClientProjectsExt,
6+
ClientExperimentalExt, ClientLoginExt, ClientProjectsExt,
77
ClientSystemHardwareExt, ClientSystemIpPoolsExt, ClientSystemStatusExt,
88
ClientVpcsExt,
99
types::{

‎end-to-end-tests/src/instance_launch.rs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ use oxide_client::types::{
99
InstanceCpuCount, InstanceCreate, InstanceDiskAttachment,
1010
InstanceNetworkInterfaceAttachment, InstanceState, SshKeyCreate,
1111
};
12-
use oxide_client::{ClientDisksExt, ClientInstancesExt, ClientSessionExt};
12+
use oxide_client::{ClientCurrentUserExt, ClientDisksExt, ClientInstancesExt};
1313
use russh::{ChannelMsg, Disconnect};
1414
use russh_keys::PublicKeyBase64;
1515
use russh_keys::key::{KeyPair, PublicKey};

‎nexus/external-api/output/nexus_tags.txt

Lines changed: 29 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -10,6 +10,22 @@ anti_affinity_group_member_list GET /v1/anti-affinity-groups/{anti
1010
anti_affinity_group_update PUT /v1/anti-affinity-groups/{anti_affinity_group}
1111
anti_affinity_group_view GET /v1/anti-affinity-groups/{anti_affinity_group}
1212

13+
API operations found with tag "console-auth"
14+
OPERATION ID METHOD URL PATH
15+
device_access_token POST /device/token
16+
device_auth_confirm POST /device/confirm
17+
device_auth_request POST /device/auth
18+
logout POST /v1/logout
19+
20+
API operations found with tag "current-user"
21+
OPERATION ID METHOD URL PATH
22+
current_user_groups GET /v1/me/groups
23+
current_user_ssh_key_create POST /v1/me/ssh-keys
24+
current_user_ssh_key_delete DELETE /v1/me/ssh-keys/{ssh_key}
25+
current_user_ssh_key_list GET /v1/me/ssh-keys
26+
current_user_ssh_key_view GET /v1/me/ssh-keys/{ssh_key}
27+
current_user_view GET /v1/me
28+
1329
API operations found with tag "disks"
1430
OPERATION ID METHOD URL PATH
1531
disk_bulk_write_import POST /v1/disks/{disk}/bulk-write
@@ -22,17 +38,7 @@ disk_list GET /v1/disks
2238
disk_metrics_list GET /v1/disks/{disk}/metrics/{metric}
2339
disk_view GET /v1/disks/{disk}
2440

25-
API operations found with tag "floating-ips"
26-
OPERATION ID METHOD URL PATH
27-
floating_ip_attach POST /v1/floating-ips/{floating_ip}/attach
28-
floating_ip_create POST /v1/floating-ips
29-
floating_ip_delete DELETE /v1/floating-ips/{floating_ip}
30-
floating_ip_detach POST /v1/floating-ips/{floating_ip}/detach
31-
floating_ip_list GET /v1/floating-ips
32-
floating_ip_update PUT /v1/floating-ips/{floating_ip}
33-
floating_ip_view GET /v1/floating-ips/{floating_ip}
34-
35-
API operations found with tag "hidden"
41+
API operations found with tag "experimental"
3642
OPERATION ID METHOD URL PATH
3743
affinity_group_create POST /v1/affinity-groups
3844
affinity_group_delete DELETE /v1/affinity-groups/{affinity_group}
@@ -43,11 +49,7 @@ affinity_group_member_instance_view GET /v1/affinity-groups/{affinity_
4349
affinity_group_member_list GET /v1/affinity-groups/{affinity_group}/members
4450
affinity_group_update PUT /v1/affinity-groups/{affinity_group}
4551
affinity_group_view GET /v1/affinity-groups/{affinity_group}
46-
device_access_token POST /device/token
47-
device_auth_confirm POST /device/confirm
48-
device_auth_request POST /device/auth
4952
instance_affinity_group_list GET /v1/instances/{instance}/affinity-groups
50-
logout POST /v1/logout
5153
probe_create POST /experimental/v1/probes
5254
probe_delete DELETE /experimental/v1/probes/{probe}
5355
probe_list GET /experimental/v1/probes
@@ -61,10 +63,22 @@ support_bundle_head_file HEAD /experimental/v1/system/suppor
6163
support_bundle_index GET /experimental/v1/system/support-bundles/{bundle_id}/index
6264
support_bundle_list GET /experimental/v1/system/support-bundles
6365
support_bundle_view GET /experimental/v1/system/support-bundles/{bundle_id}
66+
system_update_get_repository GET /v1/system/update/repository/{system_version}
67+
system_update_put_repository PUT /v1/system/update/repository
6468
target_release_update PUT /v1/system/update/target-release
6569
target_release_view GET /v1/system/update/target-release
6670
timeseries_query POST /v1/timeseries/query
6771

72+
API operations found with tag "floating-ips"
73+
OPERATION ID METHOD URL PATH
74+
floating_ip_attach POST /v1/floating-ips/{floating_ip}/attach
75+
floating_ip_create POST /v1/floating-ips
76+
floating_ip_delete DELETE /v1/floating-ips/{floating_ip}
77+
floating_ip_detach POST /v1/floating-ips/{floating_ip}/detach
78+
floating_ip_list GET /v1/floating-ips
79+
floating_ip_update PUT /v1/floating-ips/{floating_ip}
80+
floating_ip_view GET /v1/floating-ips/{floating_ip}
81+
6882
API operations found with tag "images"
6983
OPERATION ID METHOD URL PATH
7084
image_create POST /v1/images
@@ -131,15 +145,6 @@ OPERATION ID METHOD URL PATH
131145
role_list GET /v1/system/roles
132146
role_view GET /v1/system/roles/{role_name}
133147

134-
API operations found with tag "session"
135-
OPERATION ID METHOD URL PATH
136-
current_user_groups GET /v1/me/groups
137-
current_user_ssh_key_create POST /v1/me/ssh-keys
138-
current_user_ssh_key_delete DELETE /v1/me/ssh-keys/{ssh_key}
139-
current_user_ssh_key_list GET /v1/me/ssh-keys
140-
current_user_ssh_key_view GET /v1/me/ssh-keys/{ssh_key}
141-
current_user_view GET /v1/me
142-
143148
API operations found with tag "silos"
144149
OPERATION ID METHOD URL PATH
145150
auth_settings_update PUT /v1/auth-settings

0 commit comments

Comments
 (0)