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 AddEndpointParams ¶
type AddEndpointParams struct {
Auth string `json:"auth,omitzero" apic:"auth"`
ConfigPath string `json:"config_path" apic:"config_path"`
MaxBodyBytes int64 `json:"max_body_bytes,omitzero" apic:"max_body_bytes"`
Method string `json:"method" apic:"method"`
Path string `json:"path" apic:"path"`
RateLimit int64 `json:"rate_limit,omitzero" apic:"rate_limit"`
RequestSchema string `json:"request_schema,omitzero" apic:"request_schema"`
ResponseSchema string `json:"response_schema,omitzero" apic:"response_schema"`
// contains filtered or unexported fields
}
AddEndpointParams generated from config schema
func (*AddEndpointParams) APICBindPresent ¶ added in v0.20.0
func (v *AddEndpointParams) 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 (*AddEndpointParams) HashSecrets ¶ added in v0.15.0
func (x *AddEndpointParams) 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 AddEndpointParams. 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 (*AddEndpointParams) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *AddEndpointParams) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes AddEndpointParams 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 (AddEndpointParams) Valid ¶
func (v AddEndpointParams) Valid() error
Valid validates AddEndpointParams fields against schema constraints.
type AddMCPToolParams ¶
type AddMCPToolParams struct {
ConfigPath string `json:"config_path" apic:"config_path"`
Name string `json:"name" apic:"name"`
ParamsSchema string `json:"params_schema,omitzero" apic:"params_schema"`
ResultSchema string `json:"result_schema,omitzero" apic:"result_schema"`
// contains filtered or unexported fields
}
AddMCPToolParams generated from config schema
func (*AddMCPToolParams) APICBindPresent ¶ added in v0.20.0
func (v *AddMCPToolParams) 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 (*AddMCPToolParams) HashSecrets ¶ added in v0.15.0
func (x *AddMCPToolParams) 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 AddMCPToolParams. 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 (*AddMCPToolParams) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *AddMCPToolParams) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes AddMCPToolParams 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 (AddMCPToolParams) Valid ¶
func (v AddMCPToolParams) Valid() error
Valid validates AddMCPToolParams fields against schema constraints.
type AddSchemaParams ¶
type AddSchemaParams struct {
ConfigPath string `json:"config_path" apic:"config_path"`
Name string `json:"name" apic:"name"`
SchemaJSON string `json:"schema_json" apic:"schema_json"`
// contains filtered or unexported fields
}
AddSchemaParams generated from config schema
func (*AddSchemaParams) APICBindPresent ¶ added in v0.20.0
func (v *AddSchemaParams) 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 (*AddSchemaParams) HashSecrets ¶ added in v0.15.0
func (x *AddSchemaParams) 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 AddSchemaParams. 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 (*AddSchemaParams) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *AddSchemaParams) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes AddSchemaParams 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 (AddSchemaParams) Valid ¶
func (v AddSchemaParams) Valid() error
Valid validates AddSchemaParams fields against schema constraints.
type AddWebsocketParams ¶
type AddWebsocketParams struct {
Auth string `json:"auth,omitzero" apic:"auth"`
ConfigPath string `json:"config_path" apic:"config_path"`
MaxFrameBytes int64 `json:"max_frame_bytes,omitzero" apic:"max_frame_bytes"`
MaxMessageBytes int64 `json:"max_message_bytes,omitzero" apic:"max_message_bytes"`
MessageSchema string `json:"message_schema,omitzero" apic:"message_schema"`
Path string `json:"path" apic:"path"`
PingIntervalMs int64 `json:"ping_interval_ms,omitzero" apic:"ping_interval_ms"`
Proto string `json:"proto,omitzero" apic:"proto"`
// contains filtered or unexported fields
}
AddWebsocketParams generated from config schema
func (*AddWebsocketParams) APICBindPresent ¶ added in v0.20.0
func (v *AddWebsocketParams) 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 (*AddWebsocketParams) HashSecrets ¶ added in v0.15.0
func (x *AddWebsocketParams) 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 AddWebsocketParams. 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 (*AddWebsocketParams) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *AddWebsocketParams) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes AddWebsocketParams 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 (AddWebsocketParams) Valid ¶
func (v AddWebsocketParams) Valid() error
Valid validates AddWebsocketParams fields against schema constraints.
type ConfigPathParams ¶
type ConfigPathParams struct {
ConfigPath string `json:"config_path" apic:"config_path"`
// contains filtered or unexported fields
}
ConfigPathParams generated from config schema
func (*ConfigPathParams) APICBindPresent ¶ added in v0.20.0
func (v *ConfigPathParams) 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 (*ConfigPathParams) HashSecrets ¶ added in v0.15.0
func (x *ConfigPathParams) 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 ConfigPathParams. 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 (*ConfigPathParams) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *ConfigPathParams) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes ConfigPathParams 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 (ConfigPathParams) Valid ¶
func (v ConfigPathParams) Valid() error
Valid validates ConfigPathParams fields against schema constraints.
type GenerateParams ¶
type GenerateParams struct {
ConfigPath string `json:"config_path" apic:"config_path"`
OutputDir string `json:"output_dir" apic:"output_dir"`
// contains filtered or unexported fields
}
GenerateParams generated from config schema
func (*GenerateParams) APICBindPresent ¶ added in v0.20.0
func (v *GenerateParams) 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 (*GenerateParams) HashSecrets ¶ added in v0.15.0
func (x *GenerateParams) 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 GenerateParams. 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 (*GenerateParams) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *GenerateParams) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes GenerateParams 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 (GenerateParams) Valid ¶
func (v GenerateParams) Valid() error
Valid validates GenerateParams fields against schema constraints.
type GetSchemaParams ¶
type GetSchemaParams struct {
ConfigPath string `json:"config_path" apic:"config_path"`
Name string `json:"name" apic:"name"`
// contains filtered or unexported fields
}
GetSchemaParams generated from config schema
func (*GetSchemaParams) APICBindPresent ¶ added in v0.20.0
func (v *GetSchemaParams) 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 (*GetSchemaParams) HashSecrets ¶ added in v0.15.0
func (x *GetSchemaParams) 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 GetSchemaParams. 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 (*GetSchemaParams) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *GetSchemaParams) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes GetSchemaParams 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 (GetSchemaParams) Valid ¶
func (v GetSchemaParams) Valid() error
Valid validates GetSchemaParams fields against schema constraints.
type HealthResp ¶
type HealthResp struct {
Status string `json:"status" apic:"status"`
// contains filtered or unexported fields
}
HealthResp generated from config schema
func (*HealthResp) APICBindPresent ¶ added in v0.20.0
func (v *HealthResp) 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 (*HealthResp) HashSecrets ¶ added in v0.15.0
func (x *HealthResp) 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 HealthResp. 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 (*HealthResp) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *HealthResp) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes HealthResp 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 (HealthResp) Valid ¶
func (v HealthResp) Valid() error
Valid validates HealthResp fields against schema constraints.
type RemoveEndpointParams ¶
type RemoveEndpointParams struct {
ConfigPath string `json:"config_path" apic:"config_path"`
Method string `json:"method" apic:"method"`
Path string `json:"path" apic:"path"`
// contains filtered or unexported fields
}
RemoveEndpointParams generated from config schema
func (*RemoveEndpointParams) APICBindPresent ¶ added in v0.20.0
func (v *RemoveEndpointParams) 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 (*RemoveEndpointParams) HashSecrets ¶ added in v0.15.0
func (x *RemoveEndpointParams) 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 RemoveEndpointParams. 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 (*RemoveEndpointParams) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *RemoveEndpointParams) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes RemoveEndpointParams 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 (RemoveEndpointParams) Valid ¶
func (v RemoveEndpointParams) Valid() error
Valid validates RemoveEndpointParams fields against schema constraints.
type RemoveItemParams ¶
type RemoveItemParams struct {
ConfigPath string `json:"config_path" apic:"config_path"`
Name string `json:"name" apic:"name"`
// contains filtered or unexported fields
}
RemoveItemParams generated from config schema
func (*RemoveItemParams) APICBindPresent ¶ added in v0.20.0
func (v *RemoveItemParams) 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 (*RemoveItemParams) HashSecrets ¶ added in v0.15.0
func (x *RemoveItemParams) 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 RemoveItemParams. 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 (*RemoveItemParams) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *RemoveItemParams) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes RemoveItemParams 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 (RemoveItemParams) Valid ¶
func (v RemoveItemParams) Valid() error
Valid validates RemoveItemParams fields against schema constraints.
type RemoveWebsocketParams ¶
type RemoveWebsocketParams struct {
ConfigPath string `json:"config_path" apic:"config_path"`
Path string `json:"path" apic:"path"`
// contains filtered or unexported fields
}
RemoveWebsocketParams generated from config schema
func (*RemoveWebsocketParams) APICBindPresent ¶ added in v0.20.0
func (v *RemoveWebsocketParams) 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 (*RemoveWebsocketParams) HashSecrets ¶ added in v0.15.0
func (x *RemoveWebsocketParams) 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 RemoveWebsocketParams. 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 (*RemoveWebsocketParams) UnmarshalJSONFrom ¶ added in v0.20.0
func (v *RemoveWebsocketParams) UnmarshalJSONFrom(dec *jsontext.Decoder) error
UnmarshalJSONFrom decodes RemoveWebsocketParams 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 (RemoveWebsocketParams) Valid ¶
func (v RemoveWebsocketParams) Valid() error
Valid validates RemoveWebsocketParams fields against schema constraints.
Source Files