[1/2] make client-side-versioned APIs versioned

Author: iliana

Cargo.lock

@@ -5,7 +5,7 @@
 //! Interface for making API requests to a Bootstrap Agent
 
 progenitor::generate_api!(
-    spec = "../../openapi/bootstrap-agent.json",
+    spec = "../../openapi/bootstrap-agent/bootstrap-agent-latest.json",
     interface = Positional,
     inner_type = slog::Logger,
     pre_hook = (|log: &slog::Logger, request: &reqwest::Request| {

clients/bootstrap-agent-client/src/lib.rs

@@ -5,7 +5,7 @@
 //! Interface for installinator to make API requests.
 
 progenitor::generate_api!(
-    spec = "../../openapi/installinator.json",
+    spec = "../../openapi/installinator/installinator-latest.json",
     interface = Positional,
     inner_type = slog::Logger,
     pre_hook = (|log: &slog::Logger, request: &reqwest::Request| {

clients/installinator-client/src/lib.rs

@@ -6,7 +6,7 @@
 //! from within the control plane
 
 progenitor::generate_api!(
-    spec = "../../openapi/nexus-internal.json",
+    spec = "../../openapi/nexus-internal/nexus-internal-latest.json",
     interface = Positional,
     derives = [schemars::JsonSchema, PartialEq],
     inner_type = slog::Logger,

clients/nexus-client/src/lib.rs

@@ -5,7 +5,7 @@
 //! Interface for Sled Agent's Repo Depot to make API requests.
 
 progenitor::generate_api!(
-    spec = "../../openapi/repo-depot.json",
+    spec = "../../openapi/repo-depot/repo-depot-latest.json",
     interface = Positional,
     inner_type = slog::Logger,
     pre_hook = (|log: &slog::Logger, request: &reqwest::Request| {

clients/repo-depot-client/src/lib.rs

@@ -53,7 +53,9 @@ fn all_apis() -> anyhow::Result<ManagedApis> {
     let apis = vec![
         ManagedApiConfig {
             title: "Bootstrap Agent API",
-            versions: Versions::new_lockstep(semver::Version::new(0, 0, 1)),
+            versions: Versions::new_versioned(
+                bootstrap_agent_api::supported_versions(),
+            ),
             metadata: ManagedApiMetadata {
                 description: Some("Per-sled API for setup and teardown"),
                 contact_url: Some("https://oxide.computer"),
@@ -172,7 +174,9 @@ fn all_apis() -> anyhow::Result<ManagedApis> {
         },
         ManagedApiConfig {
             title: "Installinator API",
-            versions: Versions::new_lockstep(semver::Version::new(0, 0, 1)),
+            versions: Versions::new_versioned(
+                installinator_api::supported_versions(),
+            ),
             metadata: ManagedApiMetadata {
                 description: Some(
                     "API for installinator to fetch artifacts \
@@ -205,7 +209,9 @@ fn all_apis() -> anyhow::Result<ManagedApis> {
         },
         ManagedApiConfig {
             title: "Nexus internal API",
-            versions: Versions::new_lockstep(semver::Version::new(0, 0, 1)),
+            versions: Versions::new_versioned(
+                nexus_internal_api::supported_versions(),
+            ),
             metadata: ManagedApiMetadata {
                 description: Some("Nexus internal API"),
                 contact_url: Some("https://oxide.computer"),
@@ -261,7 +267,9 @@ fn all_apis() -> anyhow::Result<ManagedApis> {
         },
         ManagedApiConfig {
             title: "Oxide TUF Repo Depot API",
-            versions: Versions::new_lockstep(semver::Version::new(0, 0, 1)),
+            versions: Versions::new_versioned(
+                repo_depot_api::supported_versions(),
+            ),
             metadata: ManagedApiMetadata {
                 description: Some("API for fetching update artifacts"),
                 contact_url: Some("https://oxide.computer"),

dev-tools/dropshot-apis/src/main.rs

@@ -10,6 +10,7 @@ workspace = true
 [dependencies]
 anyhow.workspace = true
 dropshot.workspace = true
+dropshot-api-manager-types.workspace = true
 hyper.workspace = true
 installinator-common.workspace = true
 omicron-common.workspace = true

installinator-api/Cargo.toml

@@ -14,13 +14,20 @@ use dropshot::{
     HttpResponseHeaders, HttpResponseOk, HttpResponseUpdatedNoContent, Path,
     RequestContext, TypedBody,
 };
+use dropshot_api_manager_types::api_versions;
 use hyper::header;
 use installinator_common::EventReport;
 use omicron_uuid_kinds::MupdateUuid;
 use schemars::JsonSchema;
 use serde::Deserialize;
 use tufaceous_artifact::ArtifactHashId;
 
+api_versions!([
+    // Do not create new versions of this client-side versioned API.
+    // https://github.com/oxidecomputer/omicron/issues/9290
+    (1, INITIAL),
+]);
+
 const PROGRESS_REPORT_MAX_BYTES: usize = 4 * 1024 * 1024;
 
 #[derive(Debug, Deserialize, JsonSchema)]

installinator-api/src/lib.rs

@@ -9,11 +9,12 @@ workspace = true
 
 [dependencies]
 dropshot.workspace = true
+dropshot-api-manager-types.workspace = true
 http.workspace = true
 nexus-types.workspace = true
 omicron-common.workspace = true
 omicron-uuid-kinds.workspace = true
 omicron-workspace-hack.workspace = true
-serde.workspace = true
 schemars.workspace = true
+serde.workspace = true
 uuid.workspace = true

nexus/internal-api/Cargo.toml

@@ -9,6 +9,7 @@ use dropshot::{
     HttpResponseUpdatedNoContent, Path, Query, RequestContext, ResultsPage,
     TypedBody,
 };
+use dropshot_api_manager_types::api_versions;
 use nexus_types::{
     external_api::{
         shared::ProbeInfo,
@@ -34,6 +35,12 @@ use schemars::JsonSchema;
 use serde::{Deserialize, Serialize};
 use uuid::Uuid;
 
+api_versions!([
+    // Do not create new versions of this client-side versioned API.
+    // https://github.com/oxidecomputer/omicron/issues/9290
+    (1, INITIAL),
+]);
+
 #[dropshot::api_description]
 pub trait NexusInternalApi {
     type Context;