api

package

v0.8.5 Latest Latest Go to latest Published: Aug 19, 2025 License: Apache-2.0 Imports: 12 Imported by: 0

Details

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

Repository

github.com/adobe/aquarium-fish

Links

Open Source Insights

Documentation ¶

Overview ¶

Package api is an API definition

Index ¶

func NewV1Router(e *echo.Echo, f *fish.Fish)
type H
type Processor

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func NewV1Router ¶

func NewV1Router(e *echo.Echo, f *fish.Fish)

NewV1Router creates router for APIv1

Types ¶

type H ¶

type H map[string]any

H is a shortcut for map[string]any

type Processor ¶

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

Processor doing processing of the API request

func (*Processor) ApplicationCreatePost ¶

func (e *Processor) ApplicationCreatePost(c echo.Context) error

ApplicationCreatePost API call processor

func (*Processor) ApplicationDeallocateGet ¶

func (e *Processor) ApplicationDeallocateGet(c echo.Context, uid types.ApplicationUID) error

ApplicationDeallocateGet API call processor

func (*Processor) ApplicationGet ¶

func (e *Processor) ApplicationGet(c echo.Context, uid types.ApplicationUID) error

ApplicationGet API call processor

func (*Processor) ApplicationListGet ¶

func (e *Processor) ApplicationListGet(c echo.Context) error

ApplicationListGet API call processor

func (*Processor) ApplicationResourceAccessPut ¶ added in v0.8.0

func (e *Processor) ApplicationResourceAccessPut(c echo.Context, uid types.ApplicationResourceUID, params types.ApplicationResourceAccessPutParams) error

ApplicationResourceAccessPut API call processor

func (*Processor) ApplicationResourceGet ¶

func (e *Processor) ApplicationResourceGet(c echo.Context, uid types.ApplicationUID) error

ApplicationResourceGet API call processor

func (*Processor) ApplicationStateGet ¶

func (e *Processor) ApplicationStateGet(c echo.Context, uid types.ApplicationUID) error

ApplicationStateGet API call processor

func (*Processor) ApplicationTaskCreatePost ¶ added in v0.6.0

func (e *Processor) ApplicationTaskCreatePost(c echo.Context, appUID types.ApplicationUID) error

ApplicationTaskCreatePost API call processor

func (*Processor) ApplicationTaskGet ¶ added in v0.7.4

func (e *Processor) ApplicationTaskGet(c echo.Context, taskUID types.ApplicationTaskUID) error

ApplicationTaskGet API call processor

func (*Processor) ApplicationTaskListGet ¶ added in v0.6.0

func (e *Processor) ApplicationTaskListGet(c echo.Context, appUID types.ApplicationUID) error

ApplicationTaskListGet API call processor

func (*Processor) BasicAuth ¶

func (e *Processor) BasicAuth(username, password string, c echo.Context) (bool, error)

BasicAuth middleware to ensure API will not be used by crocodile

func (*Processor) LabelCreatePost ¶

func (e *Processor) LabelCreatePost(c echo.Context) error

LabelCreatePost API call processor

func (*Processor) LabelDelete ¶

func (e *Processor) LabelDelete(c echo.Context, uid types.LabelUID) error

LabelDelete API call processor

func (*Processor) LabelGet ¶

func (e *Processor) LabelGet(c echo.Context, uid types.LabelUID) error

LabelGet API call processor

func (*Processor) LabelListGet ¶

func (e *Processor) LabelListGet(c echo.Context, params types.LabelListGetParams) error

LabelListGet API call processor

func (*Processor) NodeListGet ¶

func (e *Processor) NodeListGet(c echo.Context) error

NodeListGet API call processor

func (*Processor) NodeThisGet ¶ added in v0.7.0

func (e *Processor) NodeThisGet(c echo.Context) error

NodeThisGet API call processor

func (*Processor) NodeThisMaintenanceGet ¶ added in v0.7.0

func (e *Processor) NodeThisMaintenanceGet(c echo.Context, params types.NodeThisMaintenanceGetParams) error

NodeThisMaintenanceGet API call processor

func (*Processor) NodeThisProfilingGet ¶ added in v0.7.3

func (*Processor) NodeThisProfilingGet(c echo.Context, handler string) error

NodeThisProfilingGet API call processor

func (*Processor) NodeThisProfilingIndexGet ¶ added in v0.7.3

func (e *Processor) NodeThisProfilingIndexGet(c echo.Context) error

NodeThisProfilingIndexGet API call processor

func (*Processor) ServiceMappingCreatePost ¶

func (e *Processor) ServiceMappingCreatePost(c echo.Context) error

ServiceMappingCreatePost API call processor

func (*Processor) ServiceMappingDelete ¶

func (e *Processor) ServiceMappingDelete(c echo.Context, uid types.ServiceMappingUID) error

ServiceMappingDelete API call processor

func (*Processor) ServiceMappingGet ¶

func (e *Processor) ServiceMappingGet(c echo.Context, uid types.ServiceMappingUID) error

ServiceMappingGet API call processor

func (*Processor) ServiceMappingListGet ¶

func (e *Processor) ServiceMappingListGet(c echo.Context) error

ServiceMappingListGet API call processor

func (*Processor) UserCreateUpdatePost ¶ added in v0.7.5

func (e *Processor) UserCreateUpdatePost(c echo.Context) error

UserCreateUpdatePost API call processor

func (*Processor) UserDelete ¶

func (e *Processor) UserDelete(c echo.Context, name string) error

UserDelete API call processor

func (*Processor) UserGet ¶

func (e *Processor) UserGet(c echo.Context, name string) error

UserGet API call processor

func (*Processor) UserListGet ¶

func (e *Processor) UserListGet(c echo.Context) error

UserListGet API call processor

func (*Processor) UserMeGet ¶

func (*Processor) UserMeGet(c echo.Context) error

UserMeGet API call processor

func (*Processor) VoteListGet ¶

func (e *Processor) VoteListGet(c echo.Context) error

VoteListGet API call processor

Source Files ¶

View all Source files

api_v1.go

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