apiv1

package
v0.0.42 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 12, 2024 License: Apache-2.0 Imports: 14 Imported by: 0

Documentation

Index

Constants

View Source 
const (
	RepositoryRegex = "^(artifacts/yum/[a-z0-9]+(?:[/._-][a-z0-9]+)*)$"
	URLPath         = "/artifacts/yum/api/v1"
)

Variables

This section is empty.

Functions

func MakeEndpointOfCreateRepository 

func MakeEndpointOfCreateRepository(s YUM) endpoint.Endpoint

MakeEndpointOfCreateRepository creates the endpoint for s.CreateRepository.

func MakeEndpointOfDeleteRepository 

func MakeEndpointOfDeleteRepository(s YUM) endpoint.Endpoint

MakeEndpointOfDeleteRepository creates the endpoint for s.DeleteRepository.

func MakeEndpointOfGetRepository 

func MakeEndpointOfGetRepository(s YUM) endpoint.Endpoint

MakeEndpointOfGetRepository creates the endpoint for s.GetRepository.

func MakeEndpointOfGetRepositoryPackage 

func MakeEndpointOfGetRepositoryPackage(s YUM) endpoint.Endpoint

MakeEndpointOfGetRepositoryPackage creates the endpoint for s.GetRepositoryPackage.

func MakeEndpointOfGetRepositoryPackageByTag added in v0.0.15 

func MakeEndpointOfGetRepositoryPackageByTag(s YUM) endpoint.Endpoint

MakeEndpointOfGetRepositoryPackageByTag creates the endpoint for s.GetRepositoryPackageByTag.

func MakeEndpointOfGetRepositorySyncStatus 

func MakeEndpointOfGetRepositorySyncStatus(s YUM) endpoint.Endpoint

MakeEndpointOfGetRepositorySyncStatus creates the endpoint for s.GetRepositorySyncStatus.

func MakeEndpointOfListRepositoryLogs 

func MakeEndpointOfListRepositoryLogs(s YUM) endpoint.Endpoint

MakeEndpointOfListRepositoryLogs creates the endpoint for s.ListRepositoryLogs.

func MakeEndpointOfListRepositoryPackages 

func MakeEndpointOfListRepositoryPackages(s YUM) endpoint.Endpoint

MakeEndpointOfListRepositoryPackages creates the endpoint for s.ListRepositoryPackages.

func MakeEndpointOfRemoveRepositoryPackage 

func MakeEndpointOfRemoveRepositoryPackage(s YUM) endpoint.Endpoint

MakeEndpointOfRemoveRepositoryPackage creates the endpoint for s.RemoveRepositoryPackage.

func MakeEndpointOfRemoveRepositoryPackageByTag added in v0.0.15 

func MakeEndpointOfRemoveRepositoryPackageByTag(s YUM) endpoint.Endpoint

MakeEndpointOfRemoveRepositoryPackageByTag creates the endpoint for s.RemoveRepositoryPackageByTag.

func MakeEndpointOfSyncRepository 

func MakeEndpointOfSyncRepository(s YUM) endpoint.Endpoint

MakeEndpointOfSyncRepository creates the endpoint for s.SyncRepository.

func MakeEndpointOfSyncRepositoryWithURL added in v0.0.21 

func MakeEndpointOfSyncRepositoryWithURL(s YUM) endpoint.Endpoint

MakeEndpointOfSyncRepositoryWithURL creates the endpoint for s.SyncRepositoryWithURL.

func MakeEndpointOfUpdateRepository 

func MakeEndpointOfUpdateRepository(s YUM) endpoint.Endpoint

MakeEndpointOfUpdateRepository creates the endpoint for s.UpdateRepository.

func NewHTTPRouter 

func NewHTTPRouter(svc YUM, codecs httpcodec.Codecs, opts ...httpoption.Option) chi.Router

func OASv2APIDoc 

func OASv2APIDoc(schema oas2.Schema) string

func RepositoryMatch added in v0.0.12 

func RepositoryMatch(repository string) bool

func ValidateCreateRepositoryRequest 

func ValidateCreateRepositoryRequest(newSchema func(*CreateRepositoryRequest) validating.Schema) httpoption.Validator

ValidateCreateRepositoryRequest creates a validator for CreateRepositoryRequest.

func ValidateDeleteRepositoryRequest 

func ValidateDeleteRepositoryRequest(newSchema func(*DeleteRepositoryRequest) validating.Schema) httpoption.Validator

ValidateDeleteRepositoryRequest creates a validator for DeleteRepositoryRequest.

func ValidateGetRepositoryPackageByTagRequest added in v0.0.15 

func ValidateGetRepositoryPackageByTagRequest(newSchema func(*GetRepositoryPackageByTagRequest) validating.Schema) httpoption.Validator

ValidateGetRepositoryPackageByTagRequest creates a validator for GetRepositoryPackageByTagRequest.

func ValidateGetRepositoryPackageRequest 

func ValidateGetRepositoryPackageRequest(newSchema func(*GetRepositoryPackageRequest) validating.Schema) httpoption.Validator

ValidateGetRepositoryPackageRequest creates a validator for GetRepositoryPackageRequest.

func ValidateGetRepositoryRequest 

func ValidateGetRepositoryRequest(newSchema func(*GetRepositoryRequest) validating.Schema) httpoption.Validator

ValidateGetRepositoryRequest creates a validator for GetRepositoryRequest.

func ValidateGetRepositorySyncStatusRequest 

func ValidateGetRepositorySyncStatusRequest(newSchema func(*GetRepositorySyncStatusRequest) validating.Schema) httpoption.Validator

ValidateGetRepositorySyncStatusRequest creates a validator for GetRepositorySyncStatusRequest.

func ValidateListRepositoryLogsRequest 

func ValidateListRepositoryLogsRequest(newSchema func(*ListRepositoryLogsRequest) validating.Schema) httpoption.Validator

ValidateListRepositoryLogsRequest creates a validator for ListRepositoryLogsRequest.

func ValidateListRepositoryPackagesRequest 

func ValidateListRepositoryPackagesRequest(newSchema func(*ListRepositoryPackagesRequest) validating.Schema) httpoption.Validator

ValidateListRepositoryPackagesRequest creates a validator for ListRepositoryPackagesRequest.

func ValidateRemoveRepositoryPackageByTagRequest added in v0.0.15 

func ValidateRemoveRepositoryPackageByTagRequest(newSchema func(*RemoveRepositoryPackageByTagRequest) validating.Schema) httpoption.Validator

ValidateRemoveRepositoryPackageByTagRequest creates a validator for RemoveRepositoryPackageByTagRequest.

func ValidateRemoveRepositoryPackageRequest 

func ValidateRemoveRepositoryPackageRequest(newSchema func(*RemoveRepositoryPackageRequest) validating.Schema) httpoption.Validator

ValidateRemoveRepositoryPackageRequest creates a validator for RemoveRepositoryPackageRequest.

func ValidateSyncRepositoryRequest 

func ValidateSyncRepositoryRequest(newSchema func(*SyncRepositoryRequest) validating.Schema) httpoption.Validator

ValidateSyncRepositoryRequest creates a validator for SyncRepositoryRequest.

func ValidateSyncRepositoryWithURLRequest added in v0.0.21 

func ValidateSyncRepositoryWithURLRequest(newSchema func(*SyncRepositoryWithURLRequest) validating.Schema) httpoption.Validator

ValidateSyncRepositoryWithURLRequest creates a validator for SyncRepositoryWithURLRequest.

func ValidateUpdateRepositoryRequest 

func ValidateUpdateRepositoryRequest(newSchema func(*UpdateRepositoryRequest) validating.Schema) httpoption.Validator

ValidateUpdateRepositoryRequest creates a validator for UpdateRepositoryRequest.

Types

type CreateRepositoryRequest 

type CreateRepositoryRequest struct {
	Repository string                `json:"repository"`
	Properties *RepositoryProperties `json:"properties"`
}

type CreateRepositoryResponse 

type CreateRepositoryResponse struct {
	Err error `json:"-"`
}

func (*CreateRepositoryResponse) Body 

func (r *CreateRepositoryResponse) Body() interface{}

func (*CreateRepositoryResponse) Failed 

func (r *CreateRepositoryResponse) Failed() error

Failed implements endpoint.Failer.

type DeleteRepositoryRequest 

type DeleteRepositoryRequest struct {
	Repository     string `json:"repository"`
	DeletePackages bool   `json:"delete_packages"`
}

type DeleteRepositoryResponse 

type DeleteRepositoryResponse struct {
	Err error `json:"-"`
}

func (*DeleteRepositoryResponse) Body 

func (r *DeleteRepositoryResponse) Body() interface{}

func (*DeleteRepositoryResponse) Failed 

func (r *DeleteRepositoryResponse) Failed() error

Failed implements endpoint.Failer.

type GetRepositoryPackageByTagRequest added in v0.0.15 

type GetRepositoryPackageByTagRequest struct {
	Repository string `json:"repository"`
	Tag        string `json:"tag"`
}

type GetRepositoryPackageByTagResponse added in v0.0.15 

type GetRepositoryPackageByTagResponse struct {
	RepositoryPackages *RepositoryPackage `json:"repository_packages"`
	Err                error              `json:"-"`
}

func (*GetRepositoryPackageByTagResponse) Body added in v0.0.15 

func (r *GetRepositoryPackageByTagResponse) Body() interface{}

func (*GetRepositoryPackageByTagResponse) Failed added in v0.0.15 

func (r *GetRepositoryPackageByTagResponse) Failed() error

Failed implements endpoint.Failer.

type GetRepositoryPackageRequest 

type GetRepositoryPackageRequest struct {
	Repository string `json:"repository"`
	Id         string `json:"id"`
}

type GetRepositoryPackageResponse 

type GetRepositoryPackageResponse struct {
	RepositoryPackages *RepositoryPackage `json:"repository_packages"`
	Err                error              `json:"-"`
}

func (*GetRepositoryPackageResponse) Body 

func (r *GetRepositoryPackageResponse) Body() interface{}

func (*GetRepositoryPackageResponse) Failed 

func (r *GetRepositoryPackageResponse) Failed() error

Failed implements endpoint.Failer.

type GetRepositoryRequest 

type GetRepositoryRequest struct {
	Repository string `json:"repository"`
}

type GetRepositoryResponse 

type GetRepositoryResponse struct {
	Properties *RepositoryProperties `json:"properties"`
	Err        error                 `json:"-"`
}

func (*GetRepositoryResponse) Body 

func (r *GetRepositoryResponse) Body() interface{}

func (*GetRepositoryResponse) Failed 

func (r *GetRepositoryResponse) Failed() error

Failed implements endpoint.Failer.

type GetRepositorySyncStatusRequest 

type GetRepositorySyncStatusRequest struct {
	Repository string `json:"repository"`
}

type GetRepositorySyncStatusResponse 

type GetRepositorySyncStatusResponse struct {
	SyncStatus *SyncStatus `json:"sync_status"`
	Err        error       `json:"-"`
}

func (*GetRepositorySyncStatusResponse) Body 

func (r *GetRepositorySyncStatusResponse) Body() interface{}

func (*GetRepositorySyncStatusResponse) Failed 

func (r *GetRepositorySyncStatusResponse) Failed() error

Failed implements endpoint.Failer.

type HTTPClient 

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

func NewHTTPClient 

func NewHTTPClient(codecs httpcodec.Codecs, httpClient *http.Client, baseURL string) (*HTTPClient, error)

func (*HTTPClient) CreateRepository 

func (c *HTTPClient) CreateRepository(ctx context.Context, repository string, properties *RepositoryProperties) (err error)

func (*HTTPClient) DeleteRepository 

func (c *HTTPClient) DeleteRepository(ctx context.Context, repository string, deletePackages bool) (err error)

func (*HTTPClient) GetRepository 

func (c *HTTPClient) GetRepository(ctx context.Context, repository string) (properties *RepositoryProperties, err error)

func (*HTTPClient) GetRepositoryPackage 

func (c *HTTPClient) GetRepositoryPackage(ctx context.Context, repository string, id string) (repositoryPackages *RepositoryPackage, err error)

func (*HTTPClient) GetRepositoryPackageByTag added in v0.0.15 

func (c *HTTPClient) GetRepositoryPackageByTag(ctx context.Context, repository string, tag string) (repositoryPackages *RepositoryPackage, err error)

func (*HTTPClient) GetRepositorySyncStatus 

func (c *HTTPClient) GetRepositorySyncStatus(ctx context.Context, repository string) (syncStatus *SyncStatus, err error)

func (*HTTPClient) ListRepositoryLogs 

func (c *HTTPClient) ListRepositoryLogs(ctx context.Context, repository string, page *Page) (logs []RepositoryLog, err error)

func (*HTTPClient) ListRepositoryPackages 

func (c *HTTPClient) ListRepositoryPackages(ctx context.Context, repository string, page *Page) (repositoryPackages []*RepositoryPackage, err error)

func (*HTTPClient) RemoveRepositoryPackage 

func (c *HTTPClient) RemoveRepositoryPackage(ctx context.Context, repository string, id string) (err error)

func (*HTTPClient) RemoveRepositoryPackageByTag added in v0.0.15 

func (c *HTTPClient) RemoveRepositoryPackageByTag(ctx context.Context, repository string, tag string) (err error)

func (*HTTPClient) SyncRepository 

func (c *HTTPClient) SyncRepository(ctx context.Context, repository string, wait bool) (err error)

func (*HTTPClient) SyncRepositoryWithURL added in v0.0.21 

func (c *HTTPClient) SyncRepositoryWithURL(ctx context.Context, repository string, mirrorURL string, wait bool) (err error)

func (*HTTPClient) UpdateRepository 

func (c *HTTPClient) UpdateRepository(ctx context.Context, repository string, properties *RepositoryProperties) (err error)

type ListRepositoryLogsRequest 

type ListRepositoryLogsRequest struct {
	Repository string `json:"repository"`
	Page       *Page  `json:"page"`
}

type ListRepositoryLogsResponse 

type ListRepositoryLogsResponse struct {
	Logs []RepositoryLog `json:"logs"`
	Err  error           `json:"-"`
}

func (*ListRepositoryLogsResponse) Body 

func (r *ListRepositoryLogsResponse) Body() interface{}

func (*ListRepositoryLogsResponse) Failed 

func (r *ListRepositoryLogsResponse) Failed() error

Failed implements endpoint.Failer.

type ListRepositoryPackagesRequest 

type ListRepositoryPackagesRequest struct {
	Repository string `json:"repository"`
	Page       *Page  `json:"page"`
}

type ListRepositoryPackagesResponse 

type ListRepositoryPackagesResponse struct {
	RepositoryPackages []*RepositoryPackage `json:"repository_packages"`
	Err                error                `json:"-"`
}

func (*ListRepositoryPackagesResponse) Body 

func (r *ListRepositoryPackagesResponse) Body() interface{}

func (*ListRepositoryPackagesResponse) Failed 

func (r *ListRepositoryPackagesResponse) Failed() error

Failed implements endpoint.Failer.

type Page 

type Page struct {
	Size  int
	Token string
}

type RemoveRepositoryPackageByTagRequest added in v0.0.15 

type RemoveRepositoryPackageByTagRequest struct {
	Repository string `json:"repository"`
	Tag        string `json:"tag"`
}

type RemoveRepositoryPackageByTagResponse added in v0.0.15 

type RemoveRepositoryPackageByTagResponse struct {
	Err error `json:"-"`
}

func (*RemoveRepositoryPackageByTagResponse) Body added in v0.0.15 

func (r *RemoveRepositoryPackageByTagResponse) Body() interface{}

func (*RemoveRepositoryPackageByTagResponse) Failed added in v0.0.15 

func (r *RemoveRepositoryPackageByTagResponse) Failed() error

Failed implements endpoint.Failer.

type RemoveRepositoryPackageRequest 

type RemoveRepositoryPackageRequest struct {
	Repository string `json:"repository"`
	Id         string `json:"id"`
}

type RemoveRepositoryPackageResponse 

type RemoveRepositoryPackageResponse struct {
	Err error `json:"-"`
}

func (*RemoveRepositoryPackageResponse) Body 

func (r *RemoveRepositoryPackageResponse) Body() interface{}

func (*RemoveRepositoryPackageResponse) Failed 

func (r *RemoveRepositoryPackageResponse) Failed() error

Failed implements endpoint.Failer.

type RepositoryLog 

type RepositoryLog struct {
	Level   string `json:"level"`
	Date    string `json:"date"`
	Message string `json:"message"`
}

Repository logs.

type RepositoryPackage 

type RepositoryPackage struct {
	Tag          string `json:"tag"`
	ID           string `json:"id"`
	Name         string `json:"name"`
	UploadTime   string `json:"upload_time"`
	BuildTime    string `json:"build_time"`
	Size         uint64 `json:"size"`
	Architecture string `json:"architecture"`
	SourceRPM    string `json:"source_rpm"`
	Version      string `json:"version"`
	Release      string `json:"release"`
	Groups       string `json:"groups"`
	License      string `json:"license"`
	Vendor       string `json:"vendor"`
	Summary      string `json:"summary"`
	Description  string `json:"description"`
	Verified     bool   `json:"verified"`
	GPGSignature string `json:"gpg_signature"`
}

Repository packages.

func (RepositoryPackage) RPMName added in v0.0.20 

func (pkg RepositoryPackage) RPMName() string

type RepositoryProperties 

type RepositoryProperties struct {
	// Configure the repository as a mirror.
	Mirror *bool `json:"mirror,omitempty"`
	// Mirror/Upstream URLs for mirroring.
	MirrorURLs []string `json:"mirror_urls,omitempty"`
	// GPG Public Key to check package signatures.
	GPGKey []byte `json:"gpg_key,omitempty"`
}

Repository properties/configuration.

type SyncRepositoryRequest 

type SyncRepositoryRequest struct {
	Repository string `json:"repository"`
	Wait       bool   `json:"wait"`
}

type SyncRepositoryResponse 

type SyncRepositoryResponse struct {
	Err error `json:"-"`
}

func (*SyncRepositoryResponse) Body 

func (r *SyncRepositoryResponse) Body() interface{}

func (*SyncRepositoryResponse) Failed 

func (r *SyncRepositoryResponse) Failed() error

Failed implements endpoint.Failer.

type SyncRepositoryWithURLRequest added in v0.0.21 

type SyncRepositoryWithURLRequest struct {
	Repository string `json:"repository"`
	MirrorURL  string `json:"mirror_url"`
	Wait       bool   `json:"wait"`
}

type SyncRepositoryWithURLResponse added in v0.0.21 

type SyncRepositoryWithURLResponse struct {
	Err error `json:"-"`
}

func (*SyncRepositoryWithURLResponse) Body added in v0.0.21 

func (r *SyncRepositoryWithURLResponse) Body() interface{}

func (*SyncRepositoryWithURLResponse) Failed added in v0.0.21 

func (r *SyncRepositoryWithURLResponse) Failed() error

Failed implements endpoint.Failer.

type SyncStatus 

type SyncStatus struct {
	Syncing        bool   `json:"syncing"`
	StartTime      string `json:"start_time"`
	EndTime        string `json:"end_time"`
	TotalPackages  int    `json:"total_packages"`
	SyncedPackages int    `json:"synced_packages"`
	SyncError      string `json:"sync_error"`
}

Mirror sync status.

type UpdateRepositoryRequest 

type UpdateRepositoryRequest struct {
	Repository string                `json:"repository"`
	Properties *RepositoryProperties `json:"properties"`
}

type UpdateRepositoryResponse 

type UpdateRepositoryResponse struct {
	Err error `json:"-"`
}

func (*UpdateRepositoryResponse) Body 

func (r *UpdateRepositoryResponse) Body() interface{}

func (*UpdateRepositoryResponse) Failed 

func (r *UpdateRepositoryResponse) Failed() error

Failed implements endpoint.Failer.

type YUM 

type YUM interface {
	// Create a YUM repository.
	//kun:op POST /repository
	//kun:success statusCode=200
	CreateRepository(ctx context.Context, repository string, properties *RepositoryProperties) (err error)

	// Delete a YUM repository.
	//kun:op DELETE /repository
	//kun:success statusCode=200
	DeleteRepository(ctx context.Context, repository string, deletePackages bool) (err error)

	// Update YUM repository properties.
	//kun:op PUT /repository
	//kun:success statusCode=200
	UpdateRepository(ctx context.Context, repository string, properties *RepositoryProperties) (err error)

	// Get YUM repository properties.
	//kun:op GET /repository
	//kun:success statusCode=200
	GetRepository(ctx context.Context, repository string) (properties *RepositoryProperties, err error)

	// Sync YUM repository with an upstream repository.
	//kun:op GET /repository/sync
	//kun:success statusCode=200
	SyncRepository(ctx context.Context, repository string, wait bool) (err error)

	// Sync YUM repository with an upstream repository using a specified URL.
	//kun:op GET /repository/sync:url
	//kun:success statusCode=200
	SyncRepositoryWithURL(ctx context.Context, repository, mirrorURL string, wait bool) (err error)

	// Get YUM repository sync status.
	//kun:op GET /repository/sync:status
	//kun:success statusCode=200
	GetRepositorySyncStatus(ctx context.Context, repository string) (syncStatus *SyncStatus, err error)

	// List YUM repository logs.
	//kun:op GET /repository/logs
	//kun:success statusCode=200
	ListRepositoryLogs(ctx context.Context, repository string, page *Page) (logs []RepositoryLog, err error)

	// Get RPM package from YUM repository.
	//kun:op GET /repository/package
	//kun:success statusCode=200
	GetRepositoryPackage(ctx context.Context, repository string, id string) (repositoryPackages *RepositoryPackage, err error)

	// Get RPM package by tag from YUM repository.
	//kun:op GET /repository/package:bytag
	//kun:success statusCode=200
	GetRepositoryPackageByTag(ctx context.Context, repository string, tag string) (repositoryPackages *RepositoryPackage, err error)

	// Remove RPM package from YUM repository.
	//kun:op DELETE /repository/package
	//kun:success statusCode=200
	RemoveRepositoryPackage(ctx context.Context, repository string, id string) (err error)

	// Remove RPM package by tag from YUM repository.
	//kun:op DELETE /repository/package:bytag
	//kun:success statusCode=200
	RemoveRepositoryPackageByTag(ctx context.Context, repository string, tag string) (err error)

	// List RPM packages for a YUM repository.
	//kun:op GET /repository/package:list
	//kun:success statusCode=200
	ListRepositoryPackages(ctx context.Context, repository string, page *Page) (repositoryPackages []*RepositoryPackage, err error)
}

YUM is used for managing YUM repositories. This is the API documentation of YUM.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.