client

Documentation

Overview

Package client constructs a configured go-openfga client from resolved config.

Index

• Constants
• func New(r config.Resolved, opts ...Option) (*openfga.Client, error)
• func ParseHeaders(raw []string) (http.Header, error)
• func ValidStoreID(id string) bool
• func ValidateStoreID(id, source string) error
• type Option
  • func WithCapture(rec apilog.Sink) Option
  • func WithTimeout(timeout time.Duration) Option

Constants

const DefaultRequestTimeout = 30 * time.Second

DefaultRequestTimeout bounds each HTTP exchange, including reading its body.

Functions

func New

func New(r config.Resolved, opts ...Option) (*openfga.Client, error)

func ParseHeaders

func ParseHeaders(raw []string) (http.Header, error)

ParseHeaders turns repeated "Name: value" strings into an http.Header.

A later value for the same name replaces an earlier one, so a --header flag overrides the same header from the profile rather than sending both.

func ValidStoreID

func ValidStoreID(id string) bool

ValidStoreID reports whether id is a well-formed store ID.

func ValidateStoreID

func ValidateStoreID(id, source string) error

ValidateStoreID returns a usage error describing a malformed store ID, naming the configuration layer it came from so the user knows what to fix. source is config.Resolved's StoreIDSource.

Types

type Option

type Option func(*options)

Option configures optional client behavior layered on top of the resolved config (e.g. request capture for the TUI).

func WithCapture

func WithCapture(rec apilog.Sink) Option

WithCapture records every HTTP request/response into rec by wrapping the base transport. The playground passes a Recorder to back its API Logs view; the CLI passes a TraceWriter under --debug to stream the exchange to stderr.

func WithTimeout

func WithTimeout(timeout time.Duration) Option

WithTimeout sets the maximum duration of each HTTP exchange. Zero disables the deadline for callers that intentionally use a long-lived endpoint.