Documentation
¶
Index ¶
- Variables
- type AddDomainRequest
- type AddPackageRequest
- type AddUserToDomainRequest
- type Client
- func (c Client) AddDomain(o *packages.DomainOptions, byUserID string) (d *packages.Domain, err error)
- func (c Client) AddPackage(o *packages.PackageOptions, byUserID string) (p *packages.Package, err error)
- func (c Client) AddUserToDomain(ref, userID, byUserID string) (err error)
- func (c Client) ChangelogForDomain(domainRef, start string, limit int) (changelog packages.Changelog, err error)
- func (c Client) ChangelogRecord(domainRef, id string) (record *packages.ChangelogRecord, err error)
- func (c Client) DeleteChangelogRecord(domainRef, id string) (record *packages.ChangelogRecord, err error)
- func (c Client) DeleteDomain(ref, byUserID string) (d *packages.Domain, err error)
- func (c Client) DeletePackage(id string, byUserID string) (p *packages.Package, err error)
- func (c Client) Domain(ref string) (d *packages.Domain, err error)
- func (c Client) DomainUsers(ref string) (users packages.DomainUsers, err error)
- func (c Client) Domains(startRef string, limit int) (page packages.DomainsPage, err error)
- func (c Client) DomainsByOwner(userID, startRef string, limit int) (p packages.DomainsPage, err error)
- func (c Client) DomainsByUser(userID, startRef string, limit int) (p packages.DomainsPage, err error)
- func (c Client) Package(id string) (p *packages.Package, err error)
- func (c Client) PackagesByDomain(domainRef, startName string, limit int) (page packages.PackagesPage, err error)
- func (c Client) RemoveUserFromDomain(ref, userID, byUserID string) (err error)
- func (c Client) ResolvePackage(path string) (resolution *packages.PackageResolution, err error)
- func (c Client) UpdateDomain(ref string, o *packages.DomainOptions, byUserID string) (d *packages.Domain, err error)
- func (c Client) UpdatePackage(id string, o *packages.PackageOptions, byUserID string) (p *packages.Package, err error)
- type DeleteDomainRequest
- type DeletePackageRequest
- type RemoveUserToDomainRequest
- type UpdateDomainRequest
- type UpdatePackageRequest
Constants ¶
This section is empty.
Variables ¶
View Source
var ( ErrForbidden = errorRegistry.MustAddMessageError(403, "Forbidden") ErrDomainNotFound = errorRegistry.MustAddMessageError(1000, "Domain Not Found") ErrDomainAlreadyExists = errorRegistry.MustAddMessageError(1001, "Domain Already Exists") ErrDomainFQDNRequired = errorRegistry.MustAddMessageError(1010, "Domain FQDN Required") ErrDomainOwnerUserIDRequired = errorRegistry.MustAddMessageError(1020, "Domain Owner User ID Required") ErrUserDoesNotExist = errorRegistry.MustAddMessageError(1100, "User Does Not Exist") ErrUserExists = errorRegistry.MustAddMessageError(1101, "User Exists") ErrPackageNotFound = errorRegistry.MustAddMessageError(2000, "Package Not Found") ErrPackageAlreadyExists = errorRegistry.MustAddMessageError(2001, "Package Already Exists") ErrPackageDomainRequired = errorRegistry.MustAddMessageError(2010, "Package Domain Required") ErrPackagePathRequired = errorRegistry.MustAddMessageError(2011, "Package Path Required") ErrPackageVCSRequired = errorRegistry.MustAddMessageError(2012, "Package VCS Required") ErrPackageRepoRootRequired = errorRegistry.MustAddMessageError(2040, "Package Repository Root Required") ErrPackageRepoRootInvalid = errorRegistry.MustAddMessageError(2041, "Package Repository Root Invalid") ErrPackageRepoRootSchemeRequired = errorRegistry.MustAddMessageError(2042, "Package Repository Root Scheme Required") ErrPackageRepoRootSchemeInvalid = errorRegistry.MustAddMessageError(2043, "Package Repository Root Scheme Invalid") ErrPackageRepoRootHostInvalid = errorRegistry.MustAddMessageError(2044, "Package Repository Root Host Invalid") ErrPackageRefChangeRejected = errorRegistry.MustAddMessageError(2070, "Package Reference Change Rejected") ErrChangelogRecordNotFound = errorRegistry.MustAddMessageError(3000, "Changelog Record Not Found") )
Errors that are returned from the HTTP server.
Functions ¶
This section is empty.
Types ¶
type AddDomainRequest ¶
type AddDomainRequest struct { Options *packages.DomainOptions `json:"options"` ByUserID string `json:"by-user-id"` }
type AddPackageRequest ¶
type AddPackageRequest struct { Options *packages.PackageOptions `json:"options"` ByUserID string `json:"by-user-id"` }
type AddUserToDomainRequest ¶
type AddUserToDomainRequest struct {
ByUserID string `json:"by-user-id"`
}
type Client ¶ added in v0.5.2
type Client struct {
*apiClient.Client
}
Client implements gopherpit.com/gopherpit/services/packages.Service interface.
func NewClient ¶ added in v0.5.2
func NewClient(c *apiClient.Client) *Client
NewClient creates a new Client.
func (Client) AddPackage ¶ added in v0.5.2
func (Client) AddUserToDomain ¶ added in v0.5.2
func (Client) ChangelogForDomain ¶ added in v0.5.2
func (Client) ChangelogRecord ¶ added in v0.5.2
func (c Client) ChangelogRecord(domainRef, id string) (record *packages.ChangelogRecord, err error)
func (Client) DeleteChangelogRecord ¶ added in v0.5.2
func (c Client) DeleteChangelogRecord(domainRef, id string) (record *packages.ChangelogRecord, err error)
func (Client) DeleteDomain ¶ added in v0.5.2
func (Client) DeletePackage ¶ added in v0.5.2
func (Client) DomainUsers ¶ added in v0.5.2
func (c Client) DomainUsers(ref string) (users packages.DomainUsers, err error)
func (Client) DomainsByOwner ¶ added in v0.5.2
func (Client) DomainsByUser ¶ added in v0.5.2
func (Client) PackagesByDomain ¶ added in v0.5.2
func (Client) RemoveUserFromDomain ¶ added in v0.5.2
func (Client) ResolvePackage ¶ added in v0.5.2
func (c Client) ResolvePackage(path string) (resolution *packages.PackageResolution, err error)
func (Client) UpdateDomain ¶ added in v0.5.2
func (Client) UpdatePackage ¶ added in v0.5.2
type DeleteDomainRequest ¶
type DeleteDomainRequest struct {
ByUserID string `json:"by-user-id"`
}
type DeletePackageRequest ¶
type DeletePackageRequest struct {
ByUserID string `json:"by-user-id"`
}
type RemoveUserToDomainRequest ¶
type RemoveUserToDomainRequest struct {
ByUserID string `json:"by-user-id"`
}
type UpdateDomainRequest ¶
type UpdateDomainRequest struct { Options *packages.DomainOptions `json:"options"` ByUserID string `json:"by-user-id"` }
type UpdatePackageRequest ¶
type UpdatePackageRequest struct { Options *packages.PackageOptions `json:"options"` ByUserID string `json:"by-user-id"` }
Click to show internal directories.
Click to hide internal directories.