http

Documentation

Index

• Variables
• func UnaryForwarderWithFieldProcessor(fieldProcessor FieldProcessor) ...
• type FieldProcessor
• type StreamForwarderFunc
  • func NewStreamForwarder(messageKey func(proto.Message) (string, error)) StreamForwarderFunc

Variables

var (
	// UnaryForwarder serializes protobuf message to JSON and removes fields using query parameter `fields`.
	// The `fields` parameter example:
	// fields=items.metadata.name,items.spec - response should include only items.metadata.name and items.spec fields
	// fields=-items.metadata.name - response should include all fields except items.metadata.name
	UnaryForwarder = func(
		ctx context.Context,
		mux *runtime.ServeMux,
		marshaler runtime.Marshaler,
		w http.ResponseWriter,
		req *http.Request,
		resp proto.Message,
		opts ...func(context.Context, http.ResponseWriter, proto.Message) error,
	) {
		runtime.ForwardResponseMessage(ctx, mux, newMarshaler(req, false), w, req, resp, opts...)
	}

	// StreamForwarder serializes protobuf message to JSON and removes fields using query parameter `fields`
	StreamForwarder = NewStreamForwarder(nil)
)

Functions

func UnaryForwarderWithFieldProcessor

func UnaryForwarderWithFieldProcessor(fieldProcessor FieldProcessor) func(
	ctx context.Context,
	mux *runtime.ServeMux,
	marshaler runtime.Marshaler,
	w http.ResponseWriter,
	req *http.Request,
	resp proto.Message,
	opts ...func(context.Context, http.ResponseWriter, proto.Message) error,
)

Types

type FieldProcessor

type FieldProcessor func(val interface{}, fields map[string]interface{}, exclude bool) (interface{}, error)

FieldProcessor is a function that handles included/excluded fields

type StreamForwarderFunc

type StreamForwarderFunc func(
	ctx context.Context,
	mux *runtime.ServeMux,
	marshaler runtime.Marshaler,
	w http.ResponseWriter,
	req *http.Request,
	recv func() (proto.Message, error),
	opts ...func(context.Context, http.ResponseWriter, proto.Message) error,
)

func NewStreamForwarder

func NewStreamForwarder(messageKey func(proto.Message) (string, error)) StreamForwarderFunc