apimodel

Documentation

Index

• type BasicMusicSet
• type BasicSetProperties
• type CreateSet
• type CreateTune
• type CreateUpdateSetProperties
• type Error
• type Health200Response
• type Health200ResponseDetails
• type Health200ResponseDetailsDatabase
• type HealthStatus
• type ImportFile
• type ImportTune
• type MusicSet
• type ObjectId
• type ParseResult
• type SetProperties
• type Tune
• type TuneProperties
• type UpdateSet
• type UpdateTune

Types

type BasicMusicSet

type BasicMusicSet struct {

	// Unique identifier for an object
	Id uuid.UUID `json:"id"`

	// The name of the Set
	Title string `json:"title"`

	// A description of the Set
	Description string `json:"description,omitempty"`

	// The name of the creator of the set
	Creator string `json:"creator,omitempty"`
}

type BasicSetProperties

type BasicSetProperties struct {

	// The name of the Set
	Title string `json:"title"`

	// A description of the Set
	Description string `json:"description,omitempty"`

	// The name of the creator of the set
	Creator string `json:"creator,omitempty"`
}

type CreateSet

type CreateSet struct {

	// The name of the Set
	Title string `json:"title"`

	// A description of the Set
	Description string `json:"description,omitempty"`

	// The name of the creator of the set
	Creator string `json:"creator,omitempty"`

	Tunes []uuid.UUID `json:"tunes,omitempty"`
}

type CreateTune

type CreateTune struct {
	Title string `json:"title"`

	Type string `json:"type,omitempty"`

	TimeSig string `json:"timeSig,omitempty"`

	Composer string `json:"composer,omitempty"`

	Arranger string `json:"arranger,omitempty"`
}

type CreateUpdateSetProperties

type CreateUpdateSetProperties struct {

	// The name of the Set
	Title string `json:"title"`

	// A description of the Set
	Description string `json:"description,omitempty"`

	// The name of the creator of the set
	Creator string `json:"creator,omitempty"`

	Tunes []uuid.UUID `json:"tunes,omitempty"`
}

type Error

type Error struct {

	// HTTP status code
	Code int32 `json:"code"`

	Message string `json:"message"`
}

type Health200Response

type Health200Response struct {
	Status HealthStatus `json:"status,omitempty"`

	Details Health200ResponseDetails `json:"details,omitempty"`
}

type Health200ResponseDetails

type Health200ResponseDetails struct {
	Database Health200ResponseDetailsDatabase `json:"database,omitempty"`
}

type Health200ResponseDetailsDatabase

type Health200ResponseDetailsDatabase struct {
	Status HealthStatus `json:"status,omitempty"`

	Timestamp time.Time `json:"timestamp,omitempty"`
}

type HealthStatus

type HealthStatus string

const (
	UP   HealthStatus = "up"
	DOWN HealthStatus = "down"
)

List of HealthStatus

type ImportFile

type ImportFile struct {
	Name string `json:"name"`

	Result ParseResult `json:"result,omitempty"`

	// if import was successful, the array of imported tunes
	Tunes []*ImportTune `json:"tunes,omitempty"`
}

type ImportTune

type ImportTune struct {

	// Unique identifier for an object
	Id uuid.UUID `json:"id"`

	Title string `json:"title"`

	Type string `json:"type,omitempty"`

	TimeSig string `json:"timeSig,omitempty"`

	Composer string `json:"composer,omitempty"`

	Arranger string `json:"arranger,omitempty"`

	Set *BasicMusicSet `json:"set,omitempty"`

	// true, if tune was imported into database, false if a tune with this title was already there
	ImportedToDatabase bool `json:"importedToDatabase,omitempty"`

	Warnings []string `json:"warnings,omitempty"`

	Errors []string `json:"errors,omitempty"`

	Infos []string `json:"infos,omitempty"`
}

type MusicSet

type MusicSet struct {

	// Unique identifier for an object
	Id uuid.UUID `json:"id"`

	// The name of the Set
	Title string `json:"title"`

	// A description of the Set
	Description string `json:"description,omitempty"`

	// The name of the creator of the set
	Creator string `json:"creator,omitempty"`

	Tunes []Tune `json:"tunes,omitempty"`
}

MusicSet - Called MusicSet and not only Set because of name clash in e.g. typescript

type ObjectId

type ObjectId struct {

	// Unique identifier for an object
	Id uuid.UUID `json:"id"`
}

type ParseResult

type ParseResult struct {
	Success bool `json:"success,omitempty"`

	Message string `json:"message,omitempty"`
}

type SetProperties

type SetProperties struct {

	// The name of the Set
	Title string `json:"title"`

	// A description of the Set
	Description string `json:"description,omitempty"`

	// The name of the creator of the set
	Creator string `json:"creator,omitempty"`

	Tunes []Tune `json:"tunes,omitempty"`
}

type Tune

type Tune struct {

	// Unique identifier for an object
	Id uuid.UUID `json:"id"`

	Title string `json:"title"`

	Type string `json:"type,omitempty"`

	TimeSig string `json:"timeSig,omitempty"`

	Composer string `json:"composer,omitempty"`

	Arranger string `json:"arranger,omitempty"`
}

type TuneProperties

type TuneProperties struct {
	Title string `json:"title"`

	Type string `json:"type,omitempty"`

	TimeSig string `json:"timeSig,omitempty"`

	Composer string `json:"composer,omitempty"`

	Arranger string `json:"arranger,omitempty"`
}

type UpdateSet

type UpdateSet struct {

	// The name of the Set
	Title string `json:"title"`

	// A description of the Set
	Description string `json:"description,omitempty"`

	// The name of the creator of the set
	Creator string `json:"creator,omitempty"`

	Tunes []uuid.UUID `json:"tunes,omitempty"`
}

type UpdateTune

type UpdateTune struct {
	Title string `json:"title"`

	Type string `json:"type,omitempty"`

	TimeSig string `json:"timeSig,omitempty"`

	Composer string `json:"composer,omitempty"`

	Arranger string `json:"arranger,omitempty"`
}