schema

type CreateObjectRequest struct {
	Body        io.Reader `json:"-"`
	IfNotExists bool      // if true, fail with ErrConflict when the object already exists
	ObjectMeta
}

type DeleteObjectRequest struct {
	GetObjectRequest
}

type DeleteObjectsRequest struct {
	Path      string `json:"path,omitempty"`
	Recursive bool   `json:"recursive,omitempty"` // if true, delete all objects recursively; if false, delete only immediate children
}

type DeleteObjectsResponse struct {
	Volume string   `json:"volume,omitempty"`
	Body   []Object `json:"body,omitempty"` // list of deleted objects
}

type GetObjectRequest struct {
	Path string
}

type Meta struct {
	Key   string          `json:"key,omitempty"`
	Value json.RawMessage `json:"value,omitempty"`
}

type Metadata struct {
	Key       string    `json:"key,omitempty"`
	IndexedAt time.Time `json:"indexed_at,omitzero"`
	MetadataCreate
}

type MetadataCreate struct {
	Filename   string    `json:"filename,omitempty"`
	Etag       string    `json:"etag,omitempty"`
	Size       int64     `json:"size"`
	ModifiedAt time.Time `json:"modified_at,omitzero"`
	MetadataMeta
}

type MetadataKV struct {
	Metadata string          `json:"-"`
	Key      string          `json:"key,omitempty"`
	Value    json.RawMessage `json:"value,omitempty"`
}

type MetadataKey string

type MetadataList struct {
	MetadataListRequest
	Count uint64      `json:"count"`
	Body  []*Metadata `json:"body"`
}

type MetadataListRequest struct {
	Title *string `json:"title,omitempty" help:"filter by title"`
	Type  *string `json:"type,omitempty" help:"media type filter"`
	pg.OffsetLimit
}

type MetadataMeta struct {
	Title    string       `json:"title,omitempty"`
	Type     string       `json:"media_type,omitempty"`
	Summary  *string      `json:"summary,omitempty"`
	Tags     []string     `json:"tags,omitempty"`
	Metadata []MetadataKV `json:"metadata,omitempty"`
}

type MetadataQueryRequest struct {
	Query string  `json:"query,omitempty" arg:"" required:"" help:"full text search query"`
	Type  *string `json:"type,omitempty" help:"media type filter"`
	pg.OffsetLimit
}

type Object struct {
	ObjectKey
	ObjectMeta
	ObjectAttr
}

type ObjectAttr struct {
	Size    int64     `json:"size"`
	ETag    *string   `json:"etag,omitempty"`
	ModTime time.Time `json:"last-modified,omitzero"`
	IsDir   bool      `json:"dir,omitempty"`
}

type ObjectCreate struct {
	ObjectKey
	ObjectMeta
	ObjectAttr
}

type ObjectKey struct {
	Volume string `json:"volume,omitempty"`
	Path   string `json:"path,omitempty"`
}

type ObjectList struct {
	ObjectListRequest
	Count int       `json:"count"`          // total number of matching objects, before offset/limit
	Body  []*Object `json:"body,omitempty"` // page of objects; nil when Limit==0 (count-only)
}

type ObjectListRequest struct {
	pg.OffsetLimit
	Volume    *string `json:"volume,omitempty"`    // optional volume name to filter by
	Path      *string `json:"path,omitempty"`      // optional path prefix within the backend
	Recursive bool    `json:"recursive,omitempty"` // if true, list all objects recursively; if false, list only immediate children
	Type      *string `json:"type,omitempty"`      // optional content type to filter by
}

type ObjectMeta struct {
	ContentType string `json:"type,omitempty"`
	Meta        []Meta `json:"meta,omitempty"`
}

type ObjectTouch ObjectKey

type ReadObjectRequest struct {
	GetObjectRequest
}

type Volume struct {
	VolumeCreate
	Name      string     `json:"name,omitempty"`
	CreatedAt time.Time  `json:"created_at,omitempty"`
	IndexedAt *time.Time `json:"indexed_at,omitempty"`
}

type VolumeCreate struct {
	URL string `json:"url,omitempty" arg:"" help:"URL of the volume to create"`
	VolumeMeta
}

type VolumeList struct {
	VolumeListRequest
	Count uint64    `json:"count,omitempty"`
	Body  []*Volume `json:"body,omitempty"`
}

type VolumeListRequest struct {
	Enabled *bool `json:"enabled,omitempty" help:"returns only enabled or disabled volumes"`
	Stale   bool  `json:"stale,omitzero" help:"returns volumes that need to be re-indexed"`
	pg.OffsetLimit
}

type VolumeMeta struct {
	Enabled    *bool          `json:"enabled,omitempty" negatable:""`
	IndexDelta *time.Duration `json:"delta,omitempty"` // if non-zero, forces a full re-index if the last index is older than this duration
}

type VolumeName string

type VolumeTouch string