models

type ArchTag struct {

	// Architecture
	// Example: amd64
	Arch string `json:"arch,omitempty"`

	// ID of the image
	// Example: project123/bioinformatics-tools/bwa:sha256.535b170e0a73cd85468464de6fcef46fb97e78d92a8dcc4cc1d09a52f2e1450c
	ImageID string `json:"imageID,omitempty"`

	// Tag name
	// Example: latest
	Tag string `json:"tag,omitempty"`
}

type ArchTagMap map[string]TagMap

type ArchTagsMapResponse struct {

	// data
	Data ArchTagMap `json:"data,omitempty"`
}

type Collection struct {

	// A list of IDs for containers belonging to this entity
	// Example: ["project123/bioinformatics-toools/bwa","project123/bioinformatics-tools/tophat"]
	Containers []string `json:"containers"`

	// The entity to which this collection belongs
	// Example: project123
	Entity string `json:"entity,omitempty"`

	// Name of the entity to which this collection belongs
	// Example: project123
	EntityName string `json:"entityName,omitempty"`

	// Unique identifier for this collection
	// Example: project123/bioinformatics-tools
	ID string `json:"id,omitempty"`

	// A collection name (regex ^[a-zA-Z0-9-]+)
	// Example: collection1
	// Required: true
	// Max Length: 255
	// Min Length: 4
	// Pattern: ^[a-z0-9]+(?:[._-][a-z0-9]+)*$
	Name *string `json:"name"`
}

type CollectionListResponse struct {

	// data
	Data []*Collection `json:"data"`
}

type CollectionReportRecord struct {

	// ID of the collection
	// Example: project123/bioinformatics-tools
	CollectionID string `json:"collectionID,omitempty"`

	// Name of the collection
	// Example: bioinformatics-tools
	CollectionName string `json:"collectionName,omitempty"`

	// Number of containers for this collection
	// Example: 6
	ContainerCount int64 `json:"containerCount,omitempty"`

	// ID of the project (entity)
	// Example: project123
	EntityID string `json:"entityID,omitempty"`

	// Name of the project (entity)
	// Example: project123
	EntityName string `json:"entityName,omitempty"`

	// Path to this collection in the library
	// Example: project123/bioinformatics-tools
	Path string `json:"path,omitempty"`

	// Size of collection in bytes
	// Example: 102400
	Size int64 `json:"size,omitempty"`
}

type CollectionReportResponse struct {

	// data
	Data []*CollectionReportRecord `json:"data"`
}

type CollectionResponse struct {

	// data
	Data *Collection `json:"data,omitempty"`
}

type Container struct {

	// arch tags
	ArchTags ArchTagMap `json:"archTags,omitempty"`

	// ID of the collection to which this container belongs
	// Example: project123/bioinformatics-tools
	Collection string `json:"collection,omitempty"`

	// Name of the collection to which this container belongs
	// Example: bioinformatics-tools
	CollectionName string `json:"collectionName,omitempty"`

	// Time container was created (managed by server)
	// Example: 2018-02-27T15:50:00+6:00
	CreatedAt string `json:"createdAt,omitempty"`

	// Marker that container is (soft) deleted
	// Example: true
	Deleted bool `json:"deleted,omitempty"`

	// A friendly description of the container
	// Example: A basic container base image, with the BWA application installed.
	Description string `json:"description,omitempty"`

	// The number of times that this container was downloaded
	// Example: 8
	DownloadCount int64 `json:"downloadCount,omitempty"`

	// ID of the entity to which this collection belongs
	// Example: project123
	Entity string `json:"entity,omitempty"`

	// Name of the entity to which this collection belongs
	// Example: project123
	EntityName string `json:"entityName,omitempty"`

	// Unique identifier for this container
	// Example: project123/bioinformatics-tools/bwa
	ID string `json:"id,omitempty"`

	// image tags
	ImageTags TagMap `json:"imageTags,omitempty"`

	// A list of IDs for the images of this container
	// Example: ["project123/bioinformatics-tools/bwa:sha256.03883ca565b32e58fa0a496316d69de35741f2ef34b5b4658a6fec04ed8149a8","project123/bioinformatics-tools/bwa:sha256.03883ca565b32e58fa0a496316d69de35741f2ef34b5b4658a6fec04ed814123"]
	Images []string `json:"images"`

	// A container name (regex ^[a-zA-Z0-9-]+)
	// Example: bwa
	// Required: true
	// Max Length: 255
	// Min Length: 4
	// Pattern: ^[a-z0-9]+(?:[._-][a-z0-9]+)*$
	Name *string `json:"name"`

	// Size in bytes of storage used by this container
	// Example: 1024000
	Size int64 `json:"size,omitempty"`

	// Time container was last updated (managed by server)
	// Example: 2018-02-27T15:50:00+6:00
	UpdatedAt string `json:"updatedAt,omitempty"`
}

type ContainerListResponse struct {

	// data
	Data []*Container `json:"data"`
}

type ContainerReportRecord struct {

	// ID of the collection
	// Example: project123/bioinformatics-tools
	CollectionID string `json:"collectionID,omitempty"`

	// Name of the collection
	// Example: bioinformatics-tools
	CollectionName string `json:"collectionName,omitempty"`

	// ID of the container
	// Example: project123/bioinformatics-tools/bwa
	ContainerID string `json:"containerID,omitempty"`

	// Name of the container
	// Example: bwa
	ContainerName string `json:"containerName,omitempty"`

	// ID of the project (entity)
	// Example: project122
	EntityID string `json:"entityID,omitempty"`

	// Name of the project (entity)
	// Example: project123
	EntityName string `json:"entityName,omitempty"`

	// Number of images/versions for this container
	// Example: 2
	ImageCount int64 `json:"imageCount,omitempty"`

	// Path to this container in the library
	// Example: project123/bioinformatics-tools/bwa
	Path string `json:"path,omitempty"`

	// Size of container in bytes
	// Example: 102400
	Size int64 `json:"size,omitempty"`
}

type ContainerReportResponse struct {

	// data
	Data []*ContainerReportRecord `json:"data"`
}

type ContainerResponse struct {

	// data
	Data *Container `json:"data,omitempty"`
}

type Entity struct {

	// Time entity was created (managed by server)
	// Example: 2018-02-27T15:50:00+6:00
	CreatedAt string `json:"createdAt,omitempty"`

	// Marker that new objects in the project should be private
	// Example: true
	DefaultPrivate bool `json:"defaultPrivate,omitempty"`

	// Unique identifier of this project
	// Example: project123
	ID string `json:"id,omitempty"`

	// A project name (regex ^[a-zA-Z0-9-]+)
	// Example: project123
	// Required: true
	// Max Length: 255
	// Min Length: 4
	// Pattern: ^[a-z0-9]+(?:[._-][a-z0-9]+)*$
	Name *string `json:"name"`

	// The user who is the owner of this project
	// Example: user123
	Owner string `json:"owner,omitempty"`

	// Time entity was last updated (managed by server)
	// Example: 2018-02-27T15:50:00+6:00
	UpdatedAt string `json:"updatedAt,omitempty"`
}

type EntityListResponse struct {

	// data
	Data []*Entity `json:"data"`
}

type EntityReportRecord struct {

	// Number of collections for this project (entity)
	// Example: 3
	CollectionCount int64 `json:"collectionCount,omitempty"`

	// ID of this project (entity)
	// Example: project123
	EntityID string `json:"entityID,omitempty"`

	// Name of this project (entity)
	// Example: project123
	EntityName string `json:"entityName,omitempty"`

	// Path to this project (entity) in the library
	// Example: sylabs
	Path string `json:"path,omitempty"`

	// Size of project (entity) storage used in bytes
	// Example: 102400
	Size int64 `json:"size,omitempty"`
}

type EntityReportResponse struct {

	// data
	Data []*EntityReportRecord `json:"data"`
}

type EntityResponse struct {

	// data
	Data *Entity `json:"data,omitempty"`
}

type Image struct {

	// Name of the CPU architecture of image contents
	// Example: amd64
	Arch string `json:"arch,omitempty"`

	// ID of the collection to which this container belongs
	// Example: project123/bioinformatics-tools
	Collection string `json:"collection,omitempty"`

	// Name of the collection to which this container belongs
	// Example: bioinformatics-tools
	CollectionName string `json:"collectionName,omitempty"`

	// ID of the container to which this image belongs
	// Example: project123/bioinformatics-tools/bwa
	Container string `json:"container,omitempty"`

	// Name of the container to which this image belongs
	// Example: bwa
	ContainerName string `json:"containerName,omitempty"`

	// Marker that image is (soft) deleted
	// Example: true
	Deleted bool `json:"deleted,omitempty"`

	// Friendly description
	// Example: Version 1.0.0, no optimizations.
	Description string `json:"description,omitempty"`

	// Marker that image is encrypted
	// Example: true
	Encrypted bool `json:"encrypted,omitempty"`

	// ID of the entity to which this collection belongs
	// Example: project123
	Entity string `json:"entity,omitempty"`

	// Name of the entity to which this collection belongs
	// Example: project123
	EntityName string `json:"entityName,omitempty"`

	// An image hash in sha256 or sif format
	// Example: sha256.e50a30881ace3d5944f5661d222db7bee5296be9e4dc7c1fcb7604bcae926e88
	// Max Length: 255
	// Min Length: 4
	// Pattern: ^((sha256\.[a-f0-9]{64})|(sif\.[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}))$
	Hash string `json:"hash,omitempty"`

	// Unique identifier for this image
	// Example: project123/bioinformatics-tools/bwa:sha256.03883ca565b32e58fa0a496316d69de35741f2ef34b5b4658a6fec04ed8149a8
	// Required: true
	ID *string `json:"id"`

	// Marker that image contains a signature
	// Example: true
	Signed bool `json:"signed,omitempty"`

	// Size in bytes of storage used by this image
	// Example: 1024000
	Size int64 `json:"size,omitempty"`

	// The list of tags that are assigned to this image
	// Example: ["latest","v1.0.0"]
	Tags []string `json:"tags"`

	// Marker that file was successfully uploaded for this image
	// Example: true
	Uploaded bool `json:"uploaded,omitempty"`
}

type ImageListResponse struct {

	// data
	Data []*Image `json:"data"`
}

type ImageResponse struct {

	// data
	Data *Image `json:"data,omitempty"`
}

type ImageTagsResponse struct {

	// data
	Data TagMap `json:"data,omitempty"`
}

type Json400error struct {

	// error
	Error *Json400errorError `json:"error,omitempty"`
}

type Json400errorError struct {

	// code
	// Example: 400
	Code int64 `json:"code,omitempty"`

	// message
	// Example: Bad Request
	Message string `json:"message,omitempty"`
}

type Json401error struct {

	// error
	Error *Json401errorError `json:"error,omitempty"`
}

type Json401errorError struct {

	// code
	// Example: 401
	Code int64 `json:"code,omitempty"`

	// message
	// Example: Not authorized - please authenticate
	Message string `json:"message,omitempty"`
}

type Json403error struct {

	// error
	Error *Json403errorError `json:"error,omitempty"`
}

type Json403errorError struct {

	// code
	// Example: 403
	Code int64 `json:"code,omitempty"`

	// message
	// Example: Not authorized to access this entry
	Message string `json:"message,omitempty"`
}

type Json404error struct {

	// error
	Error *Json404errorError `json:"error,omitempty"`
}

type Json404errorError struct {

	// code
	// Example: 404
	Code int64 `json:"code,omitempty"`

	// message
	// Example: Not found
	Message string `json:"message,omitempty"`
}

type Json409error struct {

	// error
	Error *Json409errorError `json:"error,omitempty"`
}

type Json409errorError struct {

	// code
	// Example: 409
	Code int64 `json:"code,omitempty"`

	// message
	// Example: Conflict
	Message string `json:"message,omitempty"`
}

type Json500error struct {

	// error
	Error *Json500errorError `json:"error,omitempty"`
}

type Json500errorError struct {

	// code
	// Example: 500
	Code int64 `json:"code,omitempty"`

	// message
	// Example: Internal server error
	Message string `json:"message,omitempty"`
}

type Json501error struct {

	// error
	Error *Json501errorError `json:"error,omitempty"`
}

type Json501errorError struct {

	// code
	// Example: 501
	Code int64 `json:"code,omitempty"`

	// message
	// Example: Not implemented
	Message string `json:"message,omitempty"`
}

type Json507error struct {

	// error
	Error *Json507errorError `json:"error,omitempty"`
}

type Json507errorError struct {

	// code
	// Example: 507
	Code int64 `json:"code,omitempty"`

	// message
	// Example: Insufficient storage
	Message string `json:"message,omitempty"`
}

type LibraryStatsResponse struct {

	// Collections count stored in cloud service
	// Example: 1000
	CollectionsStored int64 `json:"collectionsStored,omitempty"`

	// Containers count stored in cloud service
	// Example: 1000
	ContainersStored int64 `json:"containersStored,omitempty"`

	// Entities count stored in cloud service
	// Example: 1000
	EntitiesStored int64 `json:"entitiesStored,omitempty"`

	// Images count stored in cloud service
	// Example: 1000
	ImagesStored int64 `json:"imagesStored,omitempty"`
}

type SearchResponse struct {

	// data
	Data *SearchResponseData `json:"data,omitempty"`
}

type SearchResponseData struct {

	// collection
	Collection []*Collection `json:"collection"`

	// container
	Container []*Container `json:"container"`

	// entity
	Entity []*Entity `json:"entity"`

	// image
	Image []*Image `json:"image"`
}

type Tag struct {

	// id of the image
	// Example: project123/bioinformatics-tools/bwa:sha256.535b170e0a73cd85468464de6fcef46fb97e78d92a8dcc4cc1d09a52f2e1450c
	ImageID string `json:"imageID,omitempty"`

	// Tag name
	// Example: latest
	Tag string `json:"tag,omitempty"`
}

type TagMap map[string]string

type VersionResponse struct {

	// data
	Data *VersionResponseData `json:"data,omitempty"`
}

type VersionResponseData struct {

	// Version of the Library Service API that is being served.
	// Example: v1.0.0
	APIVersion string `json:"apiVersion,omitempty"`

	// Version of the Library Service.
	// Example: v1.2.0-0-gdeadbee
	Version string `json:"version,omitempty"`
}