api

package

Go to main page

Versions in this module

v0

v0.0.13

Apr 8, 2025

Changes in this version

+ var FiltersParameter = CmdParameter

+ var ForceParameter = CmdParameter

+ var GetSecretsCmdDescriptor = CmdDescriptor

+ var RestartCmdDescriptor = CmdDescriptor

+ var ResumeCmdDescriptor = CmdDescriptor

+ var SecretsParameter = CmdParameter

+ var SetSecretsCmdDescriptor = CmdDescriptor

type API

+ func (a *API) GetSecrets(ctx context.Context, alias string) (secrets map[string]any, err error)

+ func (a *API) Restart(ctx context.Context, alias string, force bool, userClient yt.Client) error

+ func (a *API) Resume(ctx context.Context, alias string) error

+ func (a *API) SetSecrets(ctx context.Context, alias string, secrets map[string]any) error

type APIConfig

+ AssignAdministerToCreator bool

type CmdParameter

+ func (c CmdParameter) AsRequired() CmdParameter

type HTTPAPI

+ func (a HTTPAPI) HandleGetSecrets(w http.ResponseWriter, r *http.Request, params map[string]any)

+ func (a HTTPAPI) HandleRestart(w http.ResponseWriter, r *http.Request, params map[string]any)

+ func (a HTTPAPI) HandleResume(w http.ResponseWriter, r *http.Request, params map[string]any)

+ func (a HTTPAPI) HandleSetSecrets(w http.ResponseWriter, r *http.Request, params map[string]any)

v0.0.12

Jun 21, 2024

v0.0.11

Mar 11, 2024

v0.0.10

Feb 12, 2024

v0.0.9

Feb 6, 2024

Changes in this version

+ var EditOptionsCmdDescriptor = CmdDescriptor

+ var OptionsToRemoveParameter = CmdParameter

+ var OptionsToSetParameter = CmdParameter

type API

+ Ytc yt.Client

+ func (a *API) EditOptions(ctx context.Context, alias string, optionsToSet map[string]any, ...) error

type HTTPAPI

+ API *API

+ L log.Logger

+ func (a HTTPAPI) HandleEditOptions(w http.ResponseWriter, r *http.Request, params map[string]any)

+ func (a HTTPAPI) ReplyOK(w http.ResponseWriter, result any)

+ func (a HTTPAPI) ReplyWithError(w http.ResponseWriter, err error)

v0.0.8

Dec 6, 2023

v0.0.7

Dec 5, 2023

Changes in this version

+ var GetBriefInfoCmdDescriptor = CmdDescriptor

+ var SpecletOptionsParameter = CmdParameter

type API

+ func (a *API) GetBriefInfo(ctx context.Context, alias string) (strawberry.OpletBriefInfo, error)

type HTTPAPI

+ func (a HTTPAPI) HandleGetBriefInfo(w http.ResponseWriter, r *http.Request, params map[string]any)

type HTTPAPIConfig

+ LocationAliases map[string][]string

v0.0.6

Oct 10, 2023

Changes in this version

+ func Marshal(v any, format FormatType) ([]byte, error)

+ func Unmarshal(data []byte, v any, format FormatType) error

+ type FormatType string

+ const DefaultFormat

+ const FormatJSON

+ const FormatYSON

+ type HandlerFunc func(api HTTPAPI, w http.ResponseWriter, r *http.Request, params map[string]any)

v0.0.5

Sep 28, 2023

v0.0.4

Aug 10, 2023

Changes in this version

+ const ActionStore

+ const ActionStoreTrue

+ var AllCommands = []CmdDescriptor

+ var AttributesParameter = CmdParameter

+ var DescribeOptionsCmdDescriptor = CmdDescriptor

+ var OptionsParameter = CmdParameter

+ var SetOptionsCmdDescriptor = CmdDescriptor

+ func ControllerRouter(cfg HTTPAPIConfig, family string, cf strawberry.ControllerFactory, ...) chi.Router

type API

+ func (a *API) DescribeOptions(ctx context.Context, alias string) ([]strawberry.OptionGroupDescriptor, error)

+ func (a *API) SetOptions(ctx context.Context, alias string, options map[string]any) error

type APIConfig

+ ControllerFactories map[string]strawberry.ControllerFactory

+ ControllerMappings map[string]string

+ func (c *APIConfig) ControllerMappingsOrDefault() map[string]string

+ type AliasWithAttrs struct

+ Alias string

+ Attrs map[string]any

type CmdDescriptor

+ Handler func(api HTTPAPI, w http.ResponseWriter, r *http.Request, params map[string]any)

type CmdParameter

+ ElementAliases []string

+ ElementDescription string

+ ElementName string

+ ElementType ParamType

+ Transformer func(any) (any, error)

type HTTPAPI

+ func (a HTTPAPI) HandleDescribeOptions(w http.ResponseWriter, r *http.Request, params map[string]any)

+ func (a HTTPAPI) HandleSetOptions(w http.ResponseWriter, r *http.Request, params map[string]any)

v0.0.3

Jun 17, 2023

Changes in this version

type HTTPAPIConfig

+ BaseAPIConfig APIConfig

+ ClusterInfos []strawberry.AgentInfo

v0.0.2

Mar 20, 2023

v0.0.1

Mar 20, 2023

Changes in this version

+ const DefaultAction

+ const DefaultValidatePool

+ const StoreAction

+ const StoreTrueAction

+ const TypeAny

+ const TypeString

+ var AliasParameter = CmdParameter

+ var CreateCmdDescriptor = CmdDescriptor

+ var ExistsCmdDescriptor = CmdDescriptor

+ var GetOptionCmdDescriptor = CmdDescriptor

+ var GetSpecletCmdDescriptor = CmdDescriptor

+ var KeyParameter = CmdParameter

+ var ListCmdDescriptor = CmdDescriptor

+ var RemoveCmdDescriptor = CmdDescriptor

+ var RemoveOptionCmdDescriptor = CmdDescriptor

+ var SetOptionCmdDescriptor = CmdDescriptor

+ var SetSpecletCmdDescriptor = CmdDescriptor

+ var SpecletParameter = CmdParameter

+ var StartCmdDescriptor = CmdDescriptor

+ var StatusCmdDescriptor = CmdDescriptor

+ var StopCmdDescriptor = CmdDescriptor

+ var UntrackedParameter = CmdParameter

+ var ValueParameter = CmdParameter

+ func HandleDescribe(w http.ResponseWriter, r *http.Request, clusters []string)

+ func HandlePing(w http.ResponseWriter, r *http.Request)

+ func NewServer(c HTTPAPIConfig, l log.Logger) *httpserver.HTTPServer

+ func RegisterHTTPAPI(cfg HTTPAPIConfig, l log.Logger) chi.Router

+ type API struct

+ func NewAPI(ytc yt.Client, cfg APIConfig, ctl strawberry.Controller, l log.Logger) *API

+ func (a *API) CheckExistence(ctx context.Context, alias string, shouldExist bool) error

+ func (a *API) CheckPermissionToOp(ctx context.Context, alias string, permission yt.Permission) error

+ func (a *API) CheckPermissionToPool(ctx context.Context, pool string, permission yt.Permission) error

+ func (a *API) Create(ctx context.Context, alias string) error

+ func (a *API) Exists(ctx context.Context, alias string) (bool, error)

+ func (a *API) GetOption(ctx context.Context, alias, key string) (value yson.RawValue, err error)

+ func (a *API) GetSpeclet(ctx context.Context, alias string) (speclet yson.RawValue, err error)

+ func (a *API) List(ctx context.Context) ([]string, error)

+ func (a *API) Remove(ctx context.Context, alias string) error

+ func (a *API) RemoveOption(ctx context.Context, alias, key string) error

+ func (a *API) SetOption(ctx context.Context, alias, key string, value any) error

+ func (a *API) SetSpeclet(ctx context.Context, alias string, speclet map[string]any) error

+ func (a *API) Start(ctx context.Context, alias string, untracked bool, userClient yt.Client) error

+ func (a *API) Status(ctx context.Context, alias string) (strawberry.OpletStatus, error)

+ func (a *API) Stop(ctx context.Context, alias string) error

+ type APIConfig struct

+ AgentInfo strawberry.AgentInfo

+ BaseACL []yt.ACE

+ ControllerConfig yson.RawValue

+ ControllerFactory strawberry.ControllerFactory

+ RobotUsername string

+ ValidatePoolAccess *bool

+ func (c *APIConfig) ValidatePoolAccessOrDefault() bool

+ type CmdDescriptor struct

+ Description string

+ Name string

+ Parameters []CmdParameter

+ type CmdParameter struct

+ Action string

+ Aliases []string

+ Description string

+ EnvVariable string

+ Name string

+ Required bool

+ Type ParamType

+ Validator func(any) error

+ func (c *CmdParameter) ActionOrDefault() string

+ func (c CmdParameter) AsExplicit() CmdParameter

+ type HTTPAPI struct

+ func NewHTTPAPI(ytc yt.Client, config APIConfig, ctl strawberry.Controller, l log.Logger) HTTPAPI

+ func (a HTTPAPI) HandleCreate(w http.ResponseWriter, r *http.Request)

+ func (a HTTPAPI) HandleExists(w http.ResponseWriter, r *http.Request)

+ func (a HTTPAPI) HandleGetOption(w http.ResponseWriter, r *http.Request)

+ func (a HTTPAPI) HandleGetSpeclet(w http.ResponseWriter, r *http.Request)

+ func (a HTTPAPI) HandleList(w http.ResponseWriter, r *http.Request)

+ func (a HTTPAPI) HandleRemove(w http.ResponseWriter, r *http.Request)

+ func (a HTTPAPI) HandleRemoveOption(w http.ResponseWriter, r *http.Request)

+ func (a HTTPAPI) HandleSetOption(w http.ResponseWriter, r *http.Request)

+ func (a HTTPAPI) HandleSetSpeclet(w http.ResponseWriter, r *http.Request)

+ func (a HTTPAPI) HandleStart(w http.ResponseWriter, r *http.Request)

+ func (a HTTPAPI) HandleStatus(w http.ResponseWriter, r *http.Request)

+ func (a HTTPAPI) HandleStop(w http.ResponseWriter, r *http.Request)

+ type HTTPAPIConfig struct

+ Clusters []string

+ DisableAuth bool

+ Endpoint string

+ Token string

+ type ParamType string

+ type RequestParams struct

+ Params map[string]any

+ Unparsed bool

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