api

Documentation

Index

• Constants
• Variables
• func HostingMiddleware(githubService *github.GithubService) gin.HandlerFunc
• func OwnerMiddleware() gin.HandlerFunc
• func PathMiddleware() gin.HandlerFunc
• func RepoMiddleware() gin.HandlerFunc
• func RespondError(ctx *gin.Context, status int, msg string, errs ...error)
• func RespondJSON(c *gin.Context, status int, payload interface{})
• func Routes(r *gin.Engine, h *Handler, githubService *github.GithubService)
• type CommitForm
• type ContentTypeFilter
• type CreateBranchForm
• type DeleteBranchUri
• type ErrorModel
  • func (e *ErrorModel) Error() string
  • func (e *ErrorModel) GetStatus() int
• type FileContentForm
• type FileURI
• type Handler
  • func NewHandler(cfg *config.Config, e *gin.Engine) *Handler
  • func (h *Handler) CreateBranch(ctx *gin.Context)
  • func (h *Handler) CreateFile(ctx *gin.Context)
  • func (h *Handler) DeleteBranch(ctx *gin.Context)
  • func (h *Handler) DeleteFile(ctx *gin.Context)
  • func (h *Handler) GetBranches(ctx *gin.Context)
  • func (h *Handler) GetCommits(ctx *gin.Context)
  • func (h *Handler) GetFiles(ctx *gin.Context)
  • func (h *Handler) GetRepositories(ctx *gin.Context)
  • func (h *Handler) GetRepository(ctx *gin.Context)
  • func (h *Handler) UpdateFile(ctx *gin.Context)
• type RefForm
• type StatusError

Constants

const (
	GithubHost = "github.com"
	GitlabHost = "gitlab.com"
)

const (
	HTTPRequestValidationFailed = "HTTP Request Validation failed."
	UnknownGitProviderError     = "An error occured during Git Provider request."
)

const (
	RawMimeTypes string = "application/vnd.giteway.raw"
)

Variables

var NewError = func(status int, msg string) StatusError {
	return &ErrorModel{
		Status: status,
		Title:  http.StatusText(status),
		Detail: msg,
	}
}

Functions

func HostingMiddleware

func HostingMiddleware(githubService *github.GithubService) gin.HandlerFunc

func OwnerMiddleware

func OwnerMiddleware() gin.HandlerFunc

func PathMiddleware

func PathMiddleware() gin.HandlerFunc

func RepoMiddleware

func RepoMiddleware() gin.HandlerFunc

func RespondError

func RespondError(ctx *gin.Context, status int, msg string, errs ...error)

func RespondJSON

func RespondJSON(c *gin.Context, status int, payload interface{})

func Routes

func Routes(r *gin.Engine, h *Handler, githubService *github.GithubService)

Types

type CommitForm

type CommitForm struct {
	Message *string `form:"message,omitempty" json:"message,omitempty"`
}

type ContentTypeFilter

type ContentTypeFilter interface {
	ContentType(string) string
}

type CreateBranchForm

type CreateBranchForm struct {
	Name string `uri:"name" binding:"required"`
}

type DeleteBranchUri

type DeleteBranchUri struct {
	Branch string `uri:"branch" binding:"required"`
}

type ErrorModel

type ErrorModel struct {
	Type   string `json:"type,omitempty"`
	Title  string `json:"title,omitempty"`
	Status int    `json:"status,omitempty"`
	Detail string `json:"detail,omitempty"`
}

https://datatracker.ietf.org/doc/html/rfc7807

func (*ErrorModel) Error

func (e *ErrorModel) Error() string

func (*ErrorModel) GetStatus

func (e *ErrorModel) GetStatus() int

type FileContentForm

type FileContentForm struct {
	Encoding string     `form:"encoding,default=text" json:"encoding"`
	Content  string     `form:"content" json:"content" binding:"required"`
	Commit   CommitForm `form:"commit,omitempty" json:"commit,omitempty"`
}

type FileURI

type FileURI struct {
	Path string `uri:"path,default=/"`
}

type Handler

type Handler struct {
	// contains filtered or unexported fields
}

func NewHandler

func NewHandler(cfg *config.Config, e *gin.Engine) *Handler

func (*Handler) CreateBranch

func (h *Handler) CreateBranch(ctx *gin.Context)

func (*Handler) CreateFile

func (h *Handler) CreateFile(ctx *gin.Context)

func (*Handler) DeleteBranch

func (h *Handler) DeleteBranch(ctx *gin.Context)

func (*Handler) DeleteFile

func (h *Handler) DeleteFile(ctx *gin.Context)

func (*Handler) GetBranches

func (h *Handler) GetBranches(ctx *gin.Context)

func (*Handler) GetCommits

func (h *Handler) GetCommits(ctx *gin.Context)

func (*Handler) GetFiles

func (h *Handler) GetFiles(ctx *gin.Context)

func (*Handler) GetRepositories

func (h *Handler) GetRepositories(ctx *gin.Context)

func (*Handler) GetRepository

func (h *Handler) GetRepository(ctx *gin.Context)

func (*Handler) UpdateFile

func (h *Handler) UpdateFile(ctx *gin.Context)

type RefForm

type RefForm struct {
	Ref    *string `form:"ref,omitempty"`
	SHA    *string `form:"sha,omitempty"`
	Branch string  `form:"branch,default=main"`
}

type StatusError

type StatusError interface {
	GetStatus() int
	Error() string
}