Documentation
¶
Overview ¶
Code generated by apic; DO NOT EDIT.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AdminActionReq ¶
type AdminActionReq struct {
Action string `json:"action" apic:"action"`
Reason string `json:"reason,omitzero" apic:"reason"`
ResourceID string `json:"resource_id" apic:"resource_id"`
// contains filtered or unexported fields
}
AdminActionReq generated from config schema
func (*AdminActionReq) APICBindPresent ¶ added in v0.20.0
func (v *AdminActionReq) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*AdminActionReq) HashSecrets ¶
func (x *AdminActionReq) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes AdminActionReq. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*AdminActionReq) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *AdminActionReq) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes AdminActionReq member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (AdminActionReq) Valid ¶
func (v AdminActionReq) Valid() error
Valid validates AdminActionReq fields against schema constraints.
type AdminActionResp ¶
type AdminActionResp struct {
AffectedCount int64 `json:"affected_count,omitzero" apic:"affected_count"`
Success bool `json:"success" apic:"success"`
// contains filtered or unexported fields
}
AdminActionResp generated from config schema
func (*AdminActionResp) APICBindPresent ¶ added in v0.20.0
func (v *AdminActionResp) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*AdminActionResp) HashSecrets ¶
func (x *AdminActionResp) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes AdminActionResp. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*AdminActionResp) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *AdminActionResp) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes AdminActionResp member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (AdminActionResp) Valid ¶
func (v AdminActionResp) Valid() error
Valid validates AdminActionResp fields against schema constraints.
type AdminMetricsReq ¶
type AdminMetricsReq struct {
Threshold float64 `json:"threshold,omitzero" apic:"threshold"`
WindowMinutes int64 `json:"window_minutes" apic:"window_minutes"`
// contains filtered or unexported fields
}
AdminMetricsReq generated from config schema
func (*AdminMetricsReq) APICBindPresent ¶ added in v0.20.0
func (v *AdminMetricsReq) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*AdminMetricsReq) HashSecrets ¶
func (x *AdminMetricsReq) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes AdminMetricsReq. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*AdminMetricsReq) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *AdminMetricsReq) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes AdminMetricsReq member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (AdminMetricsReq) Valid ¶
func (v AdminMetricsReq) Valid() error
Valid validates AdminMetricsReq fields against schema constraints.
type AdminMetricsResp ¶
type AdminMetricsResp struct {
Breakdowns []jsontext.Value `json:"breakdowns,omitzero" apic:"breakdowns"`
ErrorRate float64 `json:"error_rate" apic:"error_rate"`
RequestCount int64 `json:"request_count" apic:"request_count"`
// contains filtered or unexported fields
}
AdminMetricsResp generated from config schema
func (*AdminMetricsResp) APICBindPresent ¶ added in v0.20.0
func (v *AdminMetricsResp) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*AdminMetricsResp) HashSecrets ¶
func (x *AdminMetricsResp) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes AdminMetricsResp. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*AdminMetricsResp) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *AdminMetricsResp) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes AdminMetricsResp member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (AdminMetricsResp) Valid ¶
func (v AdminMetricsResp) Valid() error
Valid validates AdminMetricsResp fields against schema constraints.
type BinaryMsg ¶
type BinaryMsg struct {
Content string `json:"content" apic:"content"`
// contains filtered or unexported fields
}
BinaryMsg generated from config schema
func (*BinaryMsg) APICBindPresent ¶ added in v0.20.0
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*BinaryMsg) HashSecrets ¶
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes BinaryMsg. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*BinaryMsg) UnmarshalJSONFrom ¶ added in v0.20.0
UnmarshalJSONFrom decodes BinaryMsg member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
type FeedMsg ¶
type FeedMsg struct {
Actor string `json:"actor,omitzero" apic:"actor"`
EventType string `json:"event_type" apic:"event_type"`
ResourceID string `json:"resource_id" apic:"resource_id"`
// contains filtered or unexported fields
}
FeedMsg generated from config schema
func (*FeedMsg) APICBindPresent ¶ added in v0.20.0
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*FeedMsg) HashSecrets ¶
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes FeedMsg. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*FeedMsg) UnmarshalJSONFrom ¶ added in v0.20.0
UnmarshalJSONFrom decodes FeedMsg member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
type PostCreateReq ¶
type PostCreateReq struct {
Body string `json:"body" apic:"body"`
Category string `json:"category" apic:"category"`
Metadata jsontext.Value `json:"metadata,omitzero" apic:"metadata"`
Priority int64 `json:"priority,omitzero" apic:"priority"`
ProjectNumber string `json:"projectNumber,omitzero" apic:"projectNumber"`
Title string `json:"title" apic:"title"`
// contains filtered or unexported fields
}
PostCreateReq generated from config schema
func (*PostCreateReq) APICBindPresent ¶ added in v0.20.0
func (v *PostCreateReq) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*PostCreateReq) HashSecrets ¶
func (x *PostCreateReq) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes PostCreateReq. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*PostCreateReq) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *PostCreateReq) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes PostCreateReq member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (PostCreateReq) Valid ¶
func (v PostCreateReq) Valid() error
Valid validates PostCreateReq fields against schema constraints.
type PostCreateResp ¶
type PostCreateResp struct {
PostID string `json:"post_id" apic:"post_id"`
ProjectNumber string `json:"projectNumber,omitzero" apic:"projectNumber"`
Slug string `json:"slug" apic:"slug"`
// contains filtered or unexported fields
}
PostCreateResp generated from config schema
func (*PostCreateResp) APICBindPresent ¶ added in v0.20.0
func (v *PostCreateResp) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*PostCreateResp) HashSecrets ¶
func (x *PostCreateResp) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes PostCreateResp. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*PostCreateResp) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *PostCreateResp) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes PostCreateResp member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (PostCreateResp) Valid ¶
func (v PostCreateResp) Valid() error
Valid validates PostCreateResp fields against schema constraints.
type PostSearchReq ¶
type PostSearchReq struct {
Category string `json:"category,omitzero" apic:"category"`
MinScore *float64 `json:"min_score,omitzero" apic:"min_score"`
Page int64 `json:"page,omitzero" apic:"page"`
Query string `json:"query" apic:"query"`
// contains filtered or unexported fields
}
PostSearchReq generated from config schema
func (*PostSearchReq) APICBindPresent ¶ added in v0.20.0
func (v *PostSearchReq) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*PostSearchReq) HashSecrets ¶
func (x *PostSearchReq) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes PostSearchReq. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*PostSearchReq) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *PostSearchReq) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes PostSearchReq member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (PostSearchReq) Valid ¶
func (v PostSearchReq) Valid() error
Valid validates PostSearchReq fields against schema constraints.
type PostSearchResp ¶
type PostSearchResp struct {
Page int64 `json:"page" apic:"page"`
Results []jsontext.Value `json:"results" apic:"results"`
Total int64 `json:"total" apic:"total"`
// contains filtered or unexported fields
}
PostSearchResp generated from config schema
func (*PostSearchResp) APICBindPresent ¶ added in v0.20.0
func (v *PostSearchResp) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*PostSearchResp) HashSecrets ¶
func (x *PostSearchResp) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes PostSearchResp. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*PostSearchResp) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *PostSearchResp) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes PostSearchResp member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (PostSearchResp) Valid ¶
func (v PostSearchResp) Valid() error
Valid validates PostSearchResp fields against schema constraints.
type RegisterReq ¶
type RegisterReq struct {
Age int64 `json:"age" apic:"age"`
Email string `json:"email" apic:"email"`
Username string `json:"username" apic:"username"`
// contains filtered or unexported fields
}
RegisterReq generated from config schema
func (*RegisterReq) APICBindPresent ¶ added in v0.20.0
func (v *RegisterReq) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*RegisterReq) HashSecrets ¶
func (x *RegisterReq) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes RegisterReq. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*RegisterReq) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *RegisterReq) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes RegisterReq member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (RegisterReq) Valid ¶
func (v RegisterReq) Valid() error
Valid validates RegisterReq fields against schema constraints.
type RegisterResp ¶
type RegisterResp struct {
CreatedAt string `json:"created_at,omitzero" apic:"created_at"`
UserID string `json:"user_id" apic:"user_id"`
// contains filtered or unexported fields
}
RegisterResp generated from config schema
func (*RegisterResp) APICBindPresent ¶ added in v0.20.0
func (v *RegisterResp) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*RegisterResp) HashSecrets ¶
func (x *RegisterResp) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes RegisterResp. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*RegisterResp) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *RegisterResp) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes RegisterResp member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (RegisterResp) Valid ¶
func (v RegisterResp) Valid() error
Valid validates RegisterResp fields against schema constraints.
type UserUpdateReq ¶
type UserUpdateReq struct {
DisplayName string `json:"display_name" apic:"display_name"`
Score float64 `json:"score,omitzero" apic:"score"`
Status string `json:"status" apic:"status"`
// contains filtered or unexported fields
}
UserUpdateReq generated from config schema
func (*UserUpdateReq) APICBindPresent ¶ added in v0.20.0
func (v *UserUpdateReq) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*UserUpdateReq) HashSecrets ¶
func (x *UserUpdateReq) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes UserUpdateReq. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*UserUpdateReq) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *UserUpdateReq) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes UserUpdateReq member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (UserUpdateReq) Valid ¶
func (v UserUpdateReq) Valid() error
Valid validates UserUpdateReq fields against schema constraints.
type UserUpdateResp ¶
type UserUpdateResp struct {
DisplayName string `json:"display_name,omitzero" apic:"display_name"`
Updated bool `json:"updated" apic:"updated"`
// contains filtered or unexported fields
}
UserUpdateResp generated from config schema
func (*UserUpdateResp) APICBindPresent ¶ added in v0.20.0
func (v *UserUpdateResp) APICBindPresent(member string)
APICBindPresent marks the schema-required member named by its JSON name as present for Valid(). It is for generated binders only: a REST handler binds a path parameter after the body decode, so the member is filled without ever appearing in the body. Unknown or untracked names do nothing. Generated — do not edit.
func (*UserUpdateResp) HashSecrets ¶
func (x *UserUpdateResp) HashSecrets(ctx context.Context) error
HashSecrets one-way hashes all hash-marked fields in place. It MUST run after Valid() and before any handler/resolver observes UserUpdateResp. After it returns nil, no plaintext secret remains in the receiver. When the struct has no hash-marked fields the body is a no-op so every binding seam can call it uniformly. Generated — do not edit.
func (*UserUpdateResp) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *UserUpdateResp) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes UserUpdateResp member by member so Valid() can tell an absent required key from an explicit null (SONNY-2538): json/v2 leaves a nil pointer or collection for both. Decoding options (RejectUnknownMembers, MatchCaseInsensitiveNames) are honoured. Generated — do not edit.
func (UserUpdateResp) Valid ¶
func (v UserUpdateResp) Valid() error
Valid validates UserUpdateResp fields against schema constraints.