httpapi

package

v0.3.0 Latest Latest Go to latest Published: Nov 12, 2026 License: Apache-2.0 Imports: 19 Imported by: 0

Details

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

Repository

github.com/CosmoGao/rollbook

Links

Open Source Insights

Documentation ¶

Overview ¶

Package httpapi exposes the catalog through a single authenticated operation dispatcher.

Index ¶

Variables
func IntArg(v string) json.RawMessage
func StringArg(v string) json.RawMessage
func WriteError(w http.ResponseWriter, err error)
func WriteJSON(w http.ResponseWriter, status int, v any)
type APIError
- func Error(err error) (int, APIError)
type Args
type Engine

Constants ¶

This section is empty.

Variables ¶

View Source

var Tools = []string{"search", "get_asset", "get_service", "list_by_host", "list_by_network", "get_site", "topology", "list_outdated", "get_changes", "get_context", "put_context", "record_note", "propose_change", "create", "update", "mark_verified", "check_versions"}

Functions ¶

func IntArg ¶

func IntArg(v string) json.RawMessage

func StringArg ¶

func StringArg(v string) json.RawMessage

func WriteError ¶

func WriteError(w http.ResponseWriter, err error)

func WriteJSON ¶

func WriteJSON(w http.ResponseWriter, status int, v any)

Types ¶

type APIError ¶

type APIError struct {
	Code    string               `json:"code"`
	Message string               `json:"message"`
	Details any                  `json:"details,omitempty"`
	Fields  []catalog.FieldError `json:"fields,omitempty"`
}

func Error ¶

func Error(err error) (int, APIError)

type Args ¶

type Args map[string]json.RawMessage

func (Args) Bool ¶

func (a Args) Bool(k string) bool

func (Args) CreateRev ¶ added in v0.3.0

func (a Args) CreateRev() (int64, error)

func (Args) Int ¶

func (a Args) Int(k string) int64

func (Args) Object ¶

func (a Args) Object() (catalog.Object, error)

func (Args) Patch ¶

func (a Args) Patch() (catalog.Patch, error)

func (Args) String ¶

func (a Args) String(k string) string

type Engine ¶

type Engine struct {
	Auth              auth.Service
	Catalog           catalog.Service
	VersionChecker    *versioncheck.Checker
	AllowInsecureHTTP bool
	TrustedProxyCIDRs []netip.Prefix
}

func (Engine) Call ¶

func (e Engine) Call(ctx context.Context, p auth.Principal, op string, a Args, via string) (any, error)

func (Engine) Handler ¶

func (e Engine) Handler() http.Handler

func (Engine) Principal ¶

func (e Engine) Principal(r *http.Request) (auth.Principal, error)

Source Files ¶

View all Source files

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