chore!: change all APIs to v3, or mark them deprecated

Co-authored-by: Claude <noreply@anthropic.com>

Author: ctron

cli/src/api/advisory.rs

@@ -4,7 +4,7 @@ use crate::common::{
     new_delete_result,
 };
 
-const ADVISORY_PATH: &str = "/v2/advisory";
+const ADVISORY_PATH: &str = "/v3/advisory";
 
 pub async fn list(client: &ApiClient, params: &ListParams) -> Result<String, ApiError> {
     client.get_with_query(ADVISORY_PATH, params).await

cli/src/api/sbom.rs

@@ -19,7 +19,7 @@ use crate::common::{
     new_delete_result,
 };
 
-const SBOM_PATH: &str = "/v2/sbom";
+const SBOM_PATH: &str = "/v3/sbom";
 
 /// Parameters for find duplicates
 pub struct FindDuplicatesParams {

modules/analysis/src/endpoints/mod.rs

@@ -53,7 +53,7 @@ struct StatusQuery {
         (status = 200, description = "Analysis status", body = AnalysisStatus),
     ),
 )]
-#[get("/v2/analysis/status")]
+#[get("/v3/analysis/status")]
 /// Get the status of the analysis service.
 pub async fn analysis_status(
     service: web::Data<AnalysisService>,
@@ -80,7 +80,7 @@ pub async fn analysis_status(
         (status = 200, description = "Retrieved component(s) located by an exact match of name, pURL, or CPE", body = PaginatedResults<Node>),
     ),
 )]
-#[get("/v2/analysis/component/{key}")]
+#[get("/v3/analysis/component/{key}")]
 /// Retrieve SBOM components (packages) by name, Package URL, or CPE.
 pub async fn get_component(
     service: web::Data<AnalysisService>,
@@ -112,7 +112,7 @@ pub async fn get_component(
         (status = 200, description = "Retrieved component(s) located by search", body = PaginatedResults<Node>),
     ),
 )]
-#[get("/v2/analysis/component")]
+#[get("/v3/analysis/component")]
 /// Retrieve SBOM components (packages) by a complex search.
 pub async fn search_component(
     service: web::Data<AnalysisService>,
@@ -143,7 +143,7 @@ pub async fn search_component(
         (status = 415, description = "Unsupported rendering format"),
     ),
 )]
-#[get("/v2/analysis/sbom/{sbom}/render.{ext}")]
+#[get("/v3/analysis/sbom/{sbom}/render.{ext}")]
 /// Render an SBOM graph
 pub async fn render_sbom_graph(
     service: web::Data<AnalysisService>,
@@ -181,7 +181,7 @@ pub async fn render_sbom_graph(
         (status = 200, description = "Retrieved latest component(s) located by search", body = PaginatedResults<Node>),
     ),
 )]
-#[get("/v2/analysis/latest/component")]
+#[get("/v3/analysis/latest/component")]
 /// Retrieve latest SBOM components (packages) by a complex search.
 pub async fn search_latest_component(
     service: web::Data<AnalysisService>,
@@ -211,7 +211,7 @@ pub async fn search_latest_component(
         (status = 200, description = "Retrieved latest component(s) located by an exact match of name, pURL, or CPE", body = PaginatedResults<Node>),
     ),
 )]
-#[get("/v2/analysis/latest/component/{key}")]
+#[get("/v3/analysis/latest/component/{key}")]
 /// Retrieve latest SBOM components (packages) by name, Package URL, or CPE.
 pub async fn get_latest_component(
     service: web::Data<AnalysisService>,

modules/analysis/src/endpoints/tests/dot.rs

@@ -14,7 +14,7 @@ async fn render_dot(ctx: &TrustifyContext) -> Result<(), anyhow::Error> {
     let sbom = sbom.id;
 
     // Ensure child has an ancestor that includes it
-    let uri = format!("/api/v2/analysis/sbom/{sbom}/render.dot");
+    let uri = format!("/api/v3/analysis/sbom/{sbom}/render.dot");
     let request: Request = TestRequest::get().uri(&uri).to_request();
     let response: String = String::from_utf8(app.call_and_read_body(request).await.into())?;
     log::debug!("{response}");
@@ -57,7 +57,7 @@ async fn render_unsupported_ext(ctx: &TrustifyContext) -> Result<(), anyhow::Err
     let sbom = sbom.id;
 
     // Ensure child has an ancestor that includes it
-    let uri = format!("/api/v2/analysis/sbom/{sbom}/render.foo");
+    let uri = format!("/api/v3/analysis/sbom/{sbom}/render.foo");
     let request: Request = TestRequest::get().uri(&uri).to_request();
     let response = app.call_service(request).await;
 

modules/analysis/src/endpoints/tests/mod.rs

@@ -184,7 +184,7 @@ async fn test_status_endpoint(ctx: &TrustifyContext) -> Result<(), anyhow::Error
         })
         .await?;
 
-    let uri = "/api/v2/analysis/status";
+    let uri = "/api/v3/analysis/status";
     let request: Request = TestRequest::get().uri(uri).to_request();
     let response: Value = app.call_and_read_body_json(request).await;
 
@@ -194,7 +194,7 @@ async fn test_status_endpoint(ctx: &TrustifyContext) -> Result<(), anyhow::Error
     // ingest duplicate sbom which has different date
     ctx.ingest_documents(["spdx/simple-dup.json"]).await?;
 
-    let uri = "/api/v2/analysis/status";
+    let uri = "/api/v3/analysis/status";
     let request: Request = TestRequest::get().uri(uri).to_request();
     let response: Value = app.call_and_read_body_json(request).await;
 

modules/analysis/src/endpoints/tests/req.rs

@@ -64,7 +64,7 @@ impl<C: CallService> ReqExt for C {
             false => "",
         };
 
-        const BASE: &str = "/api/v2/analysis/";
+        const BASE: &str = "/api/v3/analysis/";
 
         let mut uri = match loc {
             What::None => {

modules/analysis/src/endpoints/tests/spdx.rs

@@ -249,7 +249,7 @@ async fn spdx_only_contains_relationships(ctx: &TrustifyContext) -> Result<(), a
     let purl = "pkg:rpm/redhat/rubygem-google-cloud-compute@0.5.0-1.el8sat?arch=src";
 
     let uri = format!(
-        "/api/v2/analysis/component/{}?descendants=10&relationships=contains",
+        "/api/v3/analysis/component/{}?descendants=10&relationships=contains",
         urlencoding::encode(purl)
     );
     let request: Request = TestRequest::get().uri(&uri).to_request();

modules/fundamental/src/advisory/endpoints/label.rs

@@ -38,7 +38,7 @@ mod default {
         (status = 200, description = "List all unique key/value labels from all Advisories", body = Vec<Value>),
     ),
 )]
-#[get("/v2/advisory-labels")]
+#[get("/v3/advisory-labels")]
 /// List all unique key/value labels from all Advisories
 pub async fn all(
     db: web::Data<Database>,
@@ -67,7 +67,7 @@ pub async fn all(
         (status = 404, description = "The advisory could not be found"),
     ),
 )]
-#[put("/v2/advisory/{id}/label")]
+#[put("/v3/advisory/{id}/label")]
 pub async fn set(
     advisory: web::Data<AdvisoryService>,
     db: web::Data<Database>,
@@ -99,7 +99,7 @@ pub async fn set(
         (status = 404, description = "The advisory could not be found"),
     ),
 )]
-#[patch("/v2/advisory/{id}/label")]
+#[patch("/v3/advisory/{id}/label")]
 pub async fn update(
     advisory: web::Data<AdvisoryService>,
     id: web::Path<Id>,

modules/fundamental/src/advisory/endpoints/mod.rs

@@ -144,7 +144,7 @@ pub async fn get(
         (status = 404, description = "The advisory could not be found"),
     ),
 )]
-#[delete("/v2/advisory/{key}")]
+#[delete("/v3/advisory/{key}")]
 /// Delete an advisory
 pub async fn delete(
     i: web::Data<IngestorService>,
@@ -201,7 +201,7 @@ const fn default_format() -> Format {
         (status = 400, description = "The file could not be parsed as an advisory"),
     )
 )]
-#[post("/v2/advisory")]
+#[post("/v3/advisory")]
 /// Upload a new advisory
 pub async fn upload(
     service: web::Data<IngestorService>,
@@ -248,7 +248,7 @@ pub async fn upload(
         (status = 404, description = "The document could not be found"),
     )
 )]
-#[get("/v2/advisory/{key}/download")]
+#[get("/v3/advisory/{key}/download")]
 /// Download an advisory document
 pub async fn download(
     db: web::Data<Database>,

modules/fundamental/src/advisory/endpoints/test.rs

@@ -406,7 +406,7 @@ async fn upload_default_csaf_format(ctx: &TrustifyContext) -> Result<(), anyhow:
 
     let payload = document_bytes("csaf/cve-2023-33201.json").await?;
 
-    let uri = "/api/v2/advisory";
+    let uri = "/api/v3/advisory";
     let request = TestRequest::post()
         .uri(uri)
         .set_payload(payload)
@@ -444,7 +444,7 @@ async fn upload_default_csaf_format_multiple(ctx: &TrustifyContext) -> Result<()
         "csaf/rhsa-2024-2705.json",
     ];
 
-    let uri = "/api/v2/advisory";
+    let uri = "/api/v3/advisory";
 
     for file in files {
         let payload = document_bytes(file).await?;
@@ -467,7 +467,7 @@ async fn upload_osv_format(ctx: &TrustifyContext) -> Result<(), anyhow::Error> {
     let app = caller(ctx).await?;
     let payload = document_bytes("osv/RUSTSEC-2021-0079.json").await?;
 
-    let uri = "/api/v2/advisory";
+    let uri = "/api/v3/advisory";
     let request = TestRequest::post()
         .uri(uri)
         .set_payload(payload)
@@ -485,7 +485,7 @@ async fn upload_cve_format(ctx: &TrustifyContext) -> Result<(), anyhow::Error> {
     let app = caller(ctx).await?;
     let payload = document_bytes("mitre/CVE-2024-27088.json").await?;
 
-    let uri = "/api/v2/advisory";
+    let uri = "/api/v3/advisory";
     let request = TestRequest::post()
         .uri(uri)
         .set_payload(payload)
@@ -502,7 +502,7 @@ async fn upload_cve_format(ctx: &TrustifyContext) -> Result<(), anyhow::Error> {
 async fn upload_unknown_format(ctx: &TrustifyContext) -> Result<(), anyhow::Error> {
     let app = caller(ctx).await?;
 
-    let uri = "/api/v2/advisory";
+    let uri = "/api/v3/advisory";
     let request = TestRequest::post().uri(uri).to_request();
 
     let response = app.call_service(request).await;
@@ -523,7 +523,7 @@ async fn upload_with_labels(ctx: &TrustifyContext) -> Result<(), anyhow::Error>
     let app = caller(ctx).await?;
     let payload = document_bytes("csaf/cve-2023-33201.json").await?;
 
-    let uri = "/api/v2/advisory?labels.foo=bar&labels.bar=baz";
+    let uri = "/api/v3/advisory?labels.foo=bar&labels.bar=baz";
     let request = TestRequest::post()
         .uri(uri)
         .set_payload(payload)
@@ -565,7 +565,7 @@ async fn download_advisory(ctx: &TrustifyContext) -> Result<(), anyhow::Error> {
     let digest: String = Sha256::digest(document_bytes(DOC).await?).encode_hex();
     let app = caller(ctx).await?;
     ctx.ingest_document(DOC).await?;
-    let uri = format!("/api/v2/advisory/sha256:{digest}/download");
+    let uri = format!("/api/v3/advisory/sha256:{digest}/download");
     let request = TestRequest::get().uri(&uri).to_request();
     let doc: Value = app.call_and_read_body_json(request).await;
     assert_eq!(doc["document"]["tracking"]["id"], "CVE-2023-33201");
@@ -579,7 +579,7 @@ async fn download_advisory(ctx: &TrustifyContext) -> Result<(), anyhow::Error> {
 async fn download_advisory_by_id(ctx: &TrustifyContext) -> Result<(), anyhow::Error> {
     let app = caller(ctx).await?;
     let result = ctx.ingest_document(DOC).await?;
-    let uri = format!("/api/v2/advisory/urn:uuid:{}/download", result.id);
+    let uri = format!("/api/v3/advisory/urn:uuid:{}/download", result.id);
     let request = TestRequest::get().uri(&uri).to_request();
     let doc: Value = app.call_and_read_body_json(request).await;
     assert_eq!(doc["document"]["tracking"]["id"], "CVE-2023-33201");
@@ -624,7 +624,7 @@ async fn delete_advisory(ctx: &TrustifyContext) -> Result<(), anyhow::Error> {
     let response = app
         .call_service(
             TestRequest::delete()
-                .uri(&format!("/api/v2/advisory/urn:uuid:{}", doc.id))
+                .uri(&format!("/api/v3/advisory/urn:uuid:{}", doc.id))
                 .to_request(),
         )
         .await;
@@ -647,7 +647,7 @@ async fn delete_advisory(ctx: &TrustifyContext) -> Result<(), anyhow::Error> {
     let response = app
         .call_service(
             TestRequest::delete()
-                .uri(&format!("/api/v2/advisory/urn:uuid:{}", doc.id))
+                .uri(&format!("/api/v3/advisory/urn:uuid:{}", doc.id))
                 .to_request(),
         )
         .await;
@@ -743,7 +743,7 @@ async fn test_label(
         .id
         .to_string();
 
-    let mut uri = format!("/api/v2/advisory-labels?filter_text={}", encode(query));
+    let mut uri = format!("/api/v3/advisory-labels?filter_text={}", encode(query));
 
     if let Some(limit) = limit.into() {
         uri.push_str(&format!("&limit={limit}"));