models

type APIResponse[T any] struct {
	ID     string            `json:"id" example:"05aebb0d-0169-4bde-bc6d-8662e4680108"` // ID is the unique identifier of the request
	Method string            `json:"method" example:"link.list"`                        // Method is the text representation of the request (link.get)
	Params map[string]string `json:"params" example:"param:value,param2:value2"`        // Params is the parameters of the request
	Data   T                 `json:"data" swaggerignore:"true"`                         // Data is the data of the request
}

type APIResponseError[I any] struct {
	ID     string            `json:"id" example:"05aebb0d-0169-4bde-bc6d-8662e4680108"` // ID is the unique identifier of the request
	Method string            `json:"method" example:"link.list"`                        // Method is the text representation of the request (link.get)
	Params map[string]string `json:"params" example:"param:value,param2:value2"`        // Params is the parameters of the request
	Error  I                 `json:"error" swaggerignore:"true"`                        // Error is the error of the request
}

type APIResponseError400 struct {
	Code    int    `json:"code" example:"400"`
	Message string `json:"message" example:"Bad Request"`
}

type APIResponseError404 struct {
	Code    int    `json:"code" example:"404"`
	Message string `json:"message" example:"Not Found"`
}

type APIResponseError409 struct {
	Code    int    `json:"code" example:"409"`
	Message string `json:"message" example:"Conflict"`
}

type APIResponseError500 struct {
	Code    int    `json:"code" example:"500"`
	Message string `json:"message" example:"Internal Server Error"`
}

type Color struct {
	// Hex is the hex code of the color
	Hex string `json:"hex"`
}

type ColorName string

type Enabled bool

type Label struct {
	// ID is the unique identifier of the label
	ID LabelID `json:"id,omitempty" example:"f7c5c4a0-6a1f-4d4b-8a9f-5b5d6d9b8c4d"`
	LabelRequest
}

type LabelID string

type LabelRequest struct {
	// Name is the name of the label
	Name string `json:"name" example:"example" validate:"required"`

	// Color is the color of the label
	// If color is empty, set default color
	Color ColorName `json:"color,omitempty" example:"red" default:"gray" validate:"optional"`
}

type Link struct {
	// ID is the unique identifier of the link in the database
	ID LinkID `json:"id" example:"84214e93-437e-434d-96c2-22c3a63b3c67"`

	// CreatedAt is the time the link was created - RFC3339
	CreatedAt string `json:"createdAt" example:"2021-07-04T15:04:05.999999999Z"`

	// UpdatedAt is the time the link was last modified - RFC3339
	UpdatedAt string `json:"lastModified" example:"2021-07-04T15:04:05.999999999Z"`

	// Namespace is the group the link belongs to
	NameSpace string `json:"namespace" example:"prod"`

	LinkRequest
}

type LinkID string

type LinkRequest struct {
	// Name is the name of the link
	Name string `json:"name" example:"example" validate:"required"`

	// SourcePath is the path of the link
	SourcePath string `json:"sourcePath" example:"/example" validate:"required"`

	// TargetURL is the original URL
	TargetURL string `json:"targetUrl" example:"https://example.com" validate:"required"`

	// Labels is the list of labels associated with the link
	Labels []LabelID `json:"labels,omitempty" example:"a54abdd8-776c-4982-bba7-34caa58596c4,fcb0726f-9701-492c-afe7-aa7121afc9cf"`

	// Enabled is the status of the link
	Enabled Enabled `json:"enabled" example:"true" validate:"required"`
}

type Model interface {
	Validate() error
	MarshalJSON() ([]byte, error)
	UnmarshalJSON([]byte) error
}

type Namespace struct {
	NamespaceRequest

	// Links is the list of links associated with the namespace
	Links []Link `json:"links"`

	// Enabled is the status of the namespace
	Enabled Enabled `json:"enabled"`
}

type NamespaceRequest struct {
	// Name is the name of the namespace
	Name string `json:"name"`
}