v2/manifest: document layers order

This documents the order used by this crate when listing layers' digests.
camallo · Oct 15, 2018 · 4439e5b · 4439e5b
1 parent 2cd5f12
commit 4439e5b
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 1 deletion.
diff --git a/src/v2/manifest/manifest_schema1.rs b/src/v2/manifest/manifest_schema1.rs
@@ -1,6 +1,8 @@
 use v2::*;
 
 /// Manifest version 2 schema 1, signed.
+///
+/// Specification is at https://docs.docker.com/registry/spec/manifest-v2-1/.
 #[derive(Debug, Default, Deserialize, Serialize)]
 pub struct ManifestSchema1Signed {
     #[serde(rename = "schemaVersion")]
@@ -37,6 +39,9 @@ struct S1Layer {
 }
 
 impl ManifestSchema1Signed {
+    /// List digests of all layers referenced by this manifest.
+    ///
+    /// The returned layers list is ordered starting with the base image first.
     pub fn get_layers(&self) -> Vec<String> {
         self.fs_layers
             .iter()

diff --git a/src/v2/manifest/manifest_schema2.rs b/src/v2/manifest/manifest_schema2.rs
@@ -1,4 +1,6 @@
 /// Manifest version 2 schema 2.
+///
+/// Specification is at https://docs.docker.com/registry/spec/manifest-v2-2/.
 #[derive(Debug, Default, Deserialize, Serialize)]
 pub struct ManifestSchema2 {
     #[serde(rename = "schemaVersion")]
@@ -60,7 +62,9 @@ pub struct Platform {
 }
 
 impl ManifestSchema2 {
-    /// List digests of all layer referenced by this manifest.
+    /// List digests of all layers referenced by this manifest.
+    ///
+    /// The returned layers list is ordered starting with the base image first.
     pub fn get_layers(&self) -> Vec<String> {
         self.layers.iter().map(|l| l.digest.clone()).collect()
     }