docker-registry 0.9.0

A pure-Rust asynchronous library for Docker Registry HTTP API v2
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40

use log::trace;
use reqwest::{self, Method, StatusCode};

use crate::{
  errors::Result,
  v2::{manifest::OciImageIndex, *},
};

impl Client {
  /// Retrieve the list of referrers for a given manifest digest.
  ///
  /// Returns an OCI Image Index containing descriptors of manifests
  /// that reference the given digest via their `subject` field.
  ///
  /// Optionally filter by `artifact_type` (e.g. `application/vnd.example.sbom.v1`).
  ///
  /// See: <https://github.com/opencontainers/distribution-spec/blob/main/spec.md#listing-referrers>
  pub async fn get_referrers(
    &self,
    name: &str,
    digest: &str,
    artifact_type: Option<&str>,
  ) -> Result<OciImageIndex> {
    let mut ep = format!("{}/v2/{}/referrers/{}", self.base_url, name, digest);
    if let Some(at) = artifact_type {
      ep = format!("{ep}?artifactType={at}");
    }
    let url = reqwest::Url::parse(&ep)?;

    let resp = self.build_reqwest(Method::GET, url.clone()).send().await?;

    let status = resp.status();
    trace!("GET '{}' status: {:?}", resp.url(), status);

    match status {
      StatusCode::OK => Ok(resp.json::<OciImageIndex>().await?),
      _ => Err(ApiErrors::from(resp).await),
    }
  }
}