Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type GetMeResponse ¶
type Optional ¶
Optional represents a JSON object field that may be absent, present with a null value, or present with a concrete value. The zero value is "absent".
It is used on PATCH-style request structs to tell an omitted field apart from a field explicitly set to null, which a plain pointer cannot do.
Use the `omitzero` JSON tag so an absent field is left out when encoding.
func (Optional[T]) IsZero ¶
IsZero reports whether the field was absent so that encoding/json can omit it when the `omitzero` option is used.
func (Optional[T]) MarshalJSON ¶
MarshalJSON encodes the underlying value. An absent optional is omitted from the object when the field uses the `omitzero` tag.
func (Optional[T]) PrepareJSONSchema ¶
func (o Optional[T]) PrepareJSONSchema(schema *jsonschema.Schema) error
PrepareJSONSchema makes the generated schema describe the inner type T instead of the wrapper struct. This keeps Optional invisible to API clients.
It works for scalar, pointer, and map inner types. Named struct inner types can produce references that the outer reflector does not collect.
func (*Optional[T]) UnmarshalJSON ¶
UnmarshalJSON records that the field was present and decodes its value.
type SignOutRequest ¶
type SignOutRequest struct {
SessionID *string `json:"session_id,omitempty" nullable:"true"`
SignOutAll *bool `json:"sign_out_all,omitempty" nullable:"true"`
}
func (*SignOutRequest) Validate ¶
func (req *SignOutRequest) Validate() error
type SignOutResponse ¶
type SignOutResponse struct {
Message string `json:"message" required:"true" nullable:"false"`
}
Source Files