Merge pull request #11169 from syphar/docs-rs-trigger

Add `POST /api/v1/crates/{name}/{version}/rebuild_docs` API endpoint

Author: Turbo87

Cargo.lock

@@ -66,6 +66,7 @@ crates_io_cdn_logs = { path = "crates/crates_io_cdn_logs" }
 crates_io_database = { path = "crates/crates_io_database" }
 crates_io_database_dump = { path = "crates/crates_io_database_dump" }
 crates_io_diesel_helpers = { path = "crates/crates_io_diesel_helpers" }
+crates_io_docs_rs = { path = "crates/crates_io_docs_rs" }
 crates_io_env_vars = { path = "crates/crates_io_env_vars" }
 crates_io_github = { path = "crates/crates_io_github" }
 crates_io_index = { path = "crates/crates_io_index" }
@@ -138,6 +139,7 @@ utoipa-axum = "=0.2.0"
 
 [dev-dependencies]
 bytes = "=1.10.1"
+crates_io_docs_rs = { path = "crates/crates_io_docs_rs", features = ["mock"] }
 crates_io_github = { path = "crates/crates_io_github", features = ["mock"] }
 crates_io_index = { path = "crates/crates_io_index", features = ["testing"] }
 crates_io_tarball = { path = "crates/crates_io_tarball", features = ["builder"] }

Cargo.toml

@@ -0,0 +1,31 @@
+[package]
+name = "crates_io_docs_rs"
+version = "0.0.0"
+license = "MIT OR Apache-2.0"
+edition = "2024"
+
+[lints]
+workspace = true
+
+[features]
+mock = ["dep:mockall"]
+
+[dependencies]
+anyhow = "=1.0.98"
+async-trait = "=0.1.88"
+crates_io_env_vars = { path = "../crates_io_env_vars" }
+http = "=1.3.1"
+mockall = { version = "=0.13.1", optional = true }
+reqwest = { version = "=0.12.15", features = ["json"] }
+serde = { version = "=1.0.219", features = ["derive"] }
+thiserror = "=2.0.12"
+tracing = "=0.1.41"
+url = "=2.5.4"
+
+[dev-dependencies]
+claims = "=0.8.0"
+serde_json = "=1.0.140"
+mockito = "=1.7.0"
+test-case = "=3.3.1"
+tokio = { version = "=1.45.0", features = ["macros", "rt-multi-thread"] }
+tracing-subscriber = "=0.3.19"

crates/crates_io_docs_rs/Cargo.toml

@@ -0,0 +1,12 @@
+# crates_io_docs_rs
+
+This package implements functionality for interacting with the docs.rs API.
+
+It contains a `DocsRsClient` trait that defines the supported operations, that
+the crates.io codebase needs to interact with docs.rs. The `RealDocsRsClient`
+struct is an implementation of this trait that uses the `reqwest` crate to
+perform the actual HTTP requests.
+
+If the `mock` feature is enabled, a `MockDocsRsClient` struct is available,
+which can be used for testing purposes. This struct is generated automatically
+by the [`mockall`](https://docs.rs/mockall) crate.

crates/crates_io_docs_rs/README.md

@@ -0,0 +1,19 @@
+use anyhow::{Result, anyhow};
+use crates_io_docs_rs::{DEFAULT_BASE_URL, DocsRsClient, RealDocsRsClient};
+use std::env;
+use url::Url;
+
+#[tokio::main]
+async fn main() -> Result<()> {
+    tracing_subscriber::fmt::init();
+
+    let access_token = env::args()
+        .nth(1)
+        .ok_or_else(|| anyhow!("Missing access token"))?;
+
+    let docs_rs = RealDocsRsClient::new(Url::parse(DEFAULT_BASE_URL)?, access_token);
+
+    docs_rs.rebuild_docs("empty-library", "1.0.0").await?;
+
+    Ok(())
+}