req

Documentation

Index

• Constants
• func JSON(c *fiber.Ctx) error
• func ParseCharacterID(s string) (model.CharacterID, error)
• func ParseCollectionType(s string) (model.SubjectCollection, error)
• func ParseEpTypeOptional(s string) (*model.EpType, error)
• func ParseEpisodeID(s string) (model.EpisodeID, error)
• func ParseIndexID(s string) (model.IndexID, error)
• func ParsePersonID(s string) (model.PersonID, error)
• func ParseSubjectID(s string) (model.SubjectID, error)
• func ParseSubjectType(s string) (model.SubjectType, error)
• func ParseTopicID(s string) (model.TopicID, error)
• type CreatePersonalAccessToken
• type DeletePersonalAccessToken
• type IndexAddSubject
• type IndexBasicInfo
• type IndexSubjectInfo
• type PageQuery
  • func GetPageQuery(c *fiber.Ctx, defaultLimit int, maxLimit int) (PageQuery, error)
  • func (q PageQuery) Check(count int64) error
• type SubjectEpisodeCollectionPatch
  • func (v SubjectEpisodeCollectionPatch) Validate() error
• type UpdateEpisodeCollection
• type UpdateUserEpisodeCollection
• type UserLogin

Constants

const DefaultMaxPageLimit = 100

const DefaultPageLimit = 30

const EpisodeDefaultLimit = 100

const EpisodeMaxLimit = 1000

Functions

func JSON

func JSON(c *fiber.Ctx) error

func ParseCharacterID

func ParseCharacterID(s string) (model.CharacterID, error)

func ParseCollectionType

func ParseCollectionType(s string) (model.SubjectCollection, error)

func ParseEpTypeOptional

func ParseEpTypeOptional(s string) (*model.EpType, error)

func ParseEpisodeID

func ParseEpisodeID(s string) (model.EpisodeID, error)

func ParseIndexID

func ParseIndexID(s string) (model.IndexID, error)

func ParsePersonID

func ParsePersonID(s string) (model.PersonID, error)

func ParseSubjectID

func ParseSubjectID(s string) (model.SubjectID, error)

func ParseSubjectType

func ParseSubjectType(s string) (model.SubjectType, error)

func ParseTopicID

func ParseTopicID(s string) (model.TopicID, error)

Types

type CreatePersonalAccessToken

type CreatePersonalAccessToken struct {
	Name         string `json:"name"`
	DurationDays uint   `json:"duration_days" validate:"required,lte=365" validateName:"有效期"`
}

type DeletePersonalAccessToken

type DeletePersonalAccessToken struct {
	ID uint32 `json:"id" validate:"required"`
}

type IndexAddSubject

type IndexAddSubject struct {
	SubjectID model.SubjectID `json:"subject_id"`
	*IndexSubjectInfo
}

type IndexBasicInfo

type IndexBasicInfo struct {
	Title       string `json:"title"`
	Description string `json:"description"`
}

type IndexSubjectInfo

type IndexSubjectInfo struct {
	SortKey uint32 `json:"sort"`
	Comment string `json:"comment"`
}

type PageQuery

type PageQuery struct {
	Limit  int
	Offset int
}

func GetPageQuery

func GetPageQuery(c *fiber.Ctx, defaultLimit int, maxLimit int) (PageQuery, error)

func (PageQuery) Check

func (q PageQuery) Check(count int64) error

type SubjectEpisodeCollectionPatch

type SubjectEpisodeCollectionPatch struct {
	Comment   null.String                        `json:"comment"`
	Tags      []string                           `json:"tags"`
	VolStatus null.Uint32                        `json:"vol_status" doc:"只能用于书籍条目"`
	EpStatus  null.Uint32                        `json:"ep_status" doc:"只能用于书籍条目"`
	Type      null.Null[model.SubjectCollection] `json:"type"`
	Rate      null.Uint8                         `json:"rate"`
	Private   null.Bool                          `json:"private"`
}

func (SubjectEpisodeCollectionPatch) Validate

func (v SubjectEpisodeCollectionPatch) Validate() error

type UpdateEpisodeCollection

type UpdateEpisodeCollection struct {
	Type uint8 `json:"type"`
}

type UpdateUserEpisodeCollection

type UpdateUserEpisodeCollection struct {
	Type model.EpisodeCollection `json:"type"`
}

type UserLogin

type UserLogin struct {
	Email            string `json:"email" validate:"required,email"`
	Password         string `json:"password" validate:"required"`
	HCaptchaResponse string `json:"h-captcha-response" validate:"required"` //nolint:tagliatelle
}