Documentation
¶
Overview ¶
Package transformers contains SDK-owned response transformations. Presentation and output formats belong to pkg/custom and its internal rendering helpers.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func SummarizeResource ¶ added in v1.21.0
func SummarizeResource(ctx context.Context, value gjson.Result, route Route) (gjson.Result, bool, error)
SummarizeResource projects known list/get records without modifying API data. A zero summary asks the presenter to show the full value. Omitted reports whether the projection hides fields; presentation owns any explanatory hint.
Types ¶
type OutputKind ¶
type OutputKind string
OutputKind identifies the successful-response boundary being presented.
const ( OutputUnspecified OutputKind = "" OutputResponse OutputKind = "response" OutputPageItem OutputKind = "page_item" OutputStreamEvent OutputKind = "stream_event" )
type Route ¶
type Route struct {
Operation string
OutputKind OutputKind
}
Route identifies an operation independently of its presentation format.
type Transformer ¶
Transformer changes one response or iterator value before presentation. Implementations must respect cancellation and must not consume other values.
func Select ¶
func Select(route Route) Transformer
Select is the SDK-owned hook for command-specific default transformations. Only known API fields are summarized; unfamiliar routes preserve their values.
Source Files