restapi

package

v0.5.0 Latest Latest Go to latest Published: Feb 16, 2025 License: MIT Imports: 37 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/cidverse/cid

Links

Open Source Insights

Documentation ¶

Index ¶

func ListenOnAddr(e *echo.Echo, listen string)
func ListenOnSocket(e *echo.Echo, file string)
func SecureWithAPIKey(e *echo.Echo, secret string)
func Setup(handlers *APIConfig) *echo.Echo
type APIConfig
type ByVersion

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ListenOnAddr ¶

func ListenOnAddr(e *echo.Echo, listen string)

func ListenOnSocket ¶

func ListenOnSocket(e *echo.Echo, file string)

func SecureWithAPIKey ¶

func SecureWithAPIKey(e *echo.Echo, secret string)

SecureWithAPIKey secures the api with a secret access token The access token needs to be passed in Authorization Header with value Bearer <secret> For invalid key, it sends “401 - Unauthorized” response. For missing key, it sends “400 - Bad Request” response.

func Setup ¶

func Setup(handlers *APIConfig) *echo.Echo

Types ¶

type APIConfig ¶

type APIConfig struct {
	BuildID              string
	JobID                string
	ProjectDir           string
	Modules              []*analyzerapi.ProjectModule
	CurrentModule        *analyzerapi.ProjectModule
	CurrentAction        *catalog.Action
	Env                  map[string]string
	ActionConfig         string
	State                *state.ActionStateContext
	TempDir              string
	ArtifactDir          string
	ExecutableCandidates []executable.Candidate
}

type ByVersion ¶

type ByVersion []*version.Version

ByVersion implements sort.Interface

func (ByVersion) Len ¶

func (a ByVersion) Len() int

func (ByVersion) Less ¶

func (a ByVersion) Less(i, j int) bool

func (ByVersion) Swap ¶

func (a ByVersion) Swap(i, j int)

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL