controller

Documentation

Index

• type StandardResponseFields
  • func NewStandardResponseFields(id TraceID, r *http.Request) StandardResponseFields
• type TraceID
  • func NewMockTraceID() TraceID
  • func NewTraceID(id xid.ID) TraceID

Types

type StandardResponseFields

type StandardResponseFields struct {
	Path    string `json:"path,omitempty"`
	TraceID string `json:"trace_id,omitempty"`
}

StandardResponseFields is meant to be included in all response bodies and includes "standard" response fields

func NewStandardResponseFields

func NewStandardResponseFields(id TraceID, r *http.Request) StandardResponseFields

NewStandardResponseFields is an initializer for the StandardResponseFields struct

type TraceID

type TraceID struct {
	xid.ID
}

RequestID is the unique Request ID for each request

func NewMockTraceID

func NewMockTraceID() TraceID

NewMockTraceID is an initializer for TraceID which returns a static "mocked"

func NewTraceID

func NewTraceID(id xid.ID) TraceID

NewTraceID is an initializer for TraceID