...

Source file src/github.com/opencontainers/image-spec/specs-go/v1/index.go

Documentation: github.com/opencontainers/image-spec/specs-go/v1

     1  // Copyright 2016 The Linux Foundation
     2  //
     3  // Licensed under the Apache License, Version 2.0 (the "License");
     4  // you may not use this file except in compliance with the License.
     5  // You may obtain a copy of the License at
     6  //
     7  //     http://www.apache.org/licenses/LICENSE-2.0
     8  //
     9  // Unless required by applicable law or agreed to in writing, software
    10  // distributed under the License is distributed on an "AS IS" BASIS,
    11  // WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    12  // See the License for the specific language governing permissions and
    13  // limitations under the License.
    14  
    15  package v1
    16  
    17  import "github.com/opencontainers/image-spec/specs-go"
    18  
    19  // Index references manifests for various platforms.
    20  // This structure provides `application/vnd.oci.image.index.v1+json` mediatype when marshalled to JSON.
    21  type Index struct {
    22  	specs.Versioned
    23  
    24  	// MediaType specifies the type of this document data structure e.g. `application/vnd.oci.image.index.v1+json`
    25  	MediaType string `json:"mediaType,omitempty"`
    26  
    27  	// ArtifactType specifies the IANA media type of artifact when the manifest is used for an artifact.
    28  	ArtifactType string `json:"artifactType,omitempty"`
    29  
    30  	// Manifests references platform specific manifests.
    31  	Manifests []Descriptor `json:"manifests"`
    32  
    33  	// Subject is an optional link from the image manifest to another manifest forming an association between the image manifest and the other manifest.
    34  	Subject *Descriptor `json:"subject,omitempty"`
    35  
    36  	// Annotations contains arbitrary metadata for the image index.
    37  	Annotations map[string]string `json:"annotations,omitempty"`
    38  }
    39  

View as plain text