github.com/cspotcode/docker-cli@v20.10.0-rc1.0.20201201121459-3faad7acc5b8+incompatible/cli-plugins/manager/metadata.go (about)

     1  package manager
     2  
     3  const (
     4  	// NamePrefix is the prefix required on all plugin binary names
     5  	NamePrefix = "docker-"
     6  
     7  	// MetadataSubcommandName is the name of the plugin subcommand
     8  	// which must be supported by every plugin and returns the
     9  	// plugin metadata.
    10  	MetadataSubcommandName = "docker-cli-plugin-metadata"
    11  )
    12  
    13  // Metadata provided by the plugin.
    14  type Metadata struct {
    15  	// SchemaVersion describes the version of this struct. Mandatory, must be "0.1.0"
    16  	SchemaVersion string `json:",omitempty"`
    17  	// Vendor is the name of the plugin vendor. Mandatory
    18  	Vendor string `json:",omitempty"`
    19  	// Version is the optional version of this plugin.
    20  	Version string `json:",omitempty"`
    21  	// ShortDescription should be suitable for a single line help message.
    22  	ShortDescription string `json:",omitempty"`
    23  	// URL is a pointer to the plugin's homepage.
    24  	URL string `json:",omitempty"`
    25  	// Experimental specifies whether the plugin is experimental.
    26  	// Deprecated: experimental features are now always enabled in the CLI
    27  	Experimental bool `json:",omitempty"`
    28  }