apimodels

package
v1.3.22 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 13, 2025 License: AGPL-3.0 Imports: 28 Imported by: 0

Documentation

Overview

Code generated by ogen, DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func WithServerURL 

func WithServerURL(ctx context.Context, u *url.URL) context.Context

WithServerURL sets context key to override server URL.

Types

type Alg 

type Alg string

The algorithm this key can be used for. Ref: #/components/schemas/Alg 

const (
	AlgHS256            Alg = "HS256"
	AlgHS384            Alg = "HS384"
	AlgHS512            Alg = "HS512"
	AlgRS256            Alg = "RS256"
	AlgRS384            Alg = "RS384"
	AlgRS512            Alg = "RS512"
	AlgES256            Alg = "ES256"
	AlgES384            Alg = "ES384"
	AlgES512            Alg = "ES512"
	AlgPS256            Alg = "PS256"
	AlgPS384            Alg = "PS384"
	AlgPS512            Alg = "PS512"
	AlgEdDSA            Alg = "EdDSA"
	AlgRSAOAEP          Alg = "RSA-OAEP"
	AlgRSAOAEP256       Alg = "RSA-OAEP-256"
	AlgA128KW           Alg = "A128KW"
	AlgA192KW           Alg = "A192KW"
	AlgA256KW           Alg = "A256KW"
	AlgDir              Alg = "dir"
	AlgECDHES           Alg = "ECDH-ES"
	AlgECDHESA128KW     Alg = "ECDH-ES+A128KW"
	AlgECDHESA192KW     Alg = "ECDH-ES+A192KW"
	AlgECDHESA256KW     Alg = "ECDH-ES+A256KW"
	AlgA128GCMKW        Alg = "A128GCMKW"
	AlgA192GCMKW        Alg = "A192GCMKW"
	AlgA256GCMKW        Alg = "A256GCMKW"
	AlgPBES2HS256A128KW Alg = "PBES2-HS256+A128KW"
	AlgPBES2HS384A192KW Alg = "PBES2-HS384+A192KW"
	AlgPBES2HS512A256KW Alg = "PBES2-HS512+A256KW"
	AlgA128CBCHS256     Alg = "A128CBC-HS256"
	AlgA192CBCHS384     Alg = "A192CBC-HS384"
	AlgA256CBCHS512     Alg = "A256CBC-HS512"
	AlgA128GCM          Alg = "A128GCM"
	AlgA192GCM          Alg = "A192GCM"
	AlgA256GCM          Alg = "A256GCM"
)

func (Alg) AllValues 

func (Alg) AllValues() []Alg

AllValues returns all Alg values.

func (*Alg) Decode 

func (s *Alg) Decode(d *jx.Decoder) error

Decode decodes Alg from json.

func (Alg) Encode 

func (s Alg) Encode(e *jx.Encoder)

Encode encodes Alg as json.

func (Alg) MarshalJSON 

func (s Alg) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (Alg) MarshalText 

func (s Alg) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*Alg) UnmarshalJSON 

func (s *Alg) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*Alg) UnmarshalText 

func (s *Alg) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (Alg) Validate 

func (s Alg) Validate() error

type Client 

type Client struct {
	// contains filtered or unexported fields
}

Client implements OAS client.

func NewClient 

func NewClient(serverURL string, opts ...ClientOption) (*Client, error)

NewClient initializes new Client defined by OAS.

func (*Client) GetPublicKey 

func (c *Client) GetPublicKey(ctx context.Context, params GetPublicKeyParams) (GetPublicKeyRes, error)

GetPublicKey invokes getPublicKey operation.

Get a public key from its usage.

GET /public-keys

func (*Client) Healthcheck 

func (c *Client) Healthcheck(ctx context.Context) (HealthcheckRes, error)

Healthcheck invokes healthcheck operation.

Returns a detailed report of the health of the service, including every dependency.

GET /healthcheck

func (*Client) ListPublicKeys 

func (c *Client) ListPublicKeys(ctx context.Context, params ListPublicKeysParams) (ListPublicKeysRes, error)

ListPublicKeys invokes listPublicKeys operation.

Get all public keys from the service that match a given usage.

GET /public-keys/list

func (*Client) Ping 

func (c *Client) Ping(ctx context.Context) (PingRes, error)

Ping invokes ping operation.

Check the status of the service. If the service is running, a successful response is returned.

GET /ping

func (*Client) SignClaims 

func (c *Client) SignClaims(ctx context.Context, request SignClaimsReq, params SignClaimsParams) (SignClaimsRes, error)

SignClaims invokes signClaims operation.

Sign a payload using the configuration for the target usage.

POST /payload/sign

type ClientOption 

type ClientOption interface {
	// contains filtered or unexported methods
}

ClientOption is client config option.

func WithClient 

func WithClient(client ht.Client) ClientOption

WithClient specifies http client to use.

type Dependency 

type Dependency struct {
	// The name of the dependency.
	Name            string           `json:"name"`
	Status          DependencyStatus `json:"status"`
	AdditionalProps DependencyAdditional
}

Ref: #/components/schemas/Dependency

func (*Dependency) Decode 

func (s *Dependency) Decode(d *jx.Decoder) error

Decode decodes Dependency from json.

func (*Dependency) Encode 

func (s *Dependency) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*Dependency) GetAdditionalProps 

func (s *Dependency) GetAdditionalProps() DependencyAdditional

GetAdditionalProps returns the value of AdditionalProps.

func (*Dependency) GetName 

func (s *Dependency) GetName() string

GetName returns the value of Name.

func (*Dependency) GetStatus 

func (s *Dependency) GetStatus() DependencyStatus

GetStatus returns the value of Status.

func (*Dependency) MarshalJSON 

func (s *Dependency) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Dependency) SetAdditionalProps 

func (s *Dependency) SetAdditionalProps(val DependencyAdditional)

SetAdditionalProps sets the value of AdditionalProps.

func (*Dependency) SetName 

func (s *Dependency) SetName(val string)

SetName sets the value of Name.

func (*Dependency) SetStatus 

func (s *Dependency) SetStatus(val DependencyStatus)

SetStatus sets the value of Status.

func (*Dependency) UnmarshalJSON 

func (s *Dependency) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*Dependency) Validate 

func (s *Dependency) Validate() error

type DependencyAdditional 

type DependencyAdditional map[string]jx.Raw

func (*DependencyAdditional) Decode 

func (s *DependencyAdditional) Decode(d *jx.Decoder) error

Decode decodes DependencyAdditional from json.

func (DependencyAdditional) Encode 

func (s DependencyAdditional) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (DependencyAdditional) MarshalJSON 

func (s DependencyAdditional) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*DependencyAdditional) UnmarshalJSON 

func (s *DependencyAdditional) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type DependencyStatus 

type DependencyStatus string

The status of a dependency. Ref: #/components/schemas/DependencyStatus 

const (
	DependencyStatusUp      DependencyStatus = "up"
	DependencyStatusDown    DependencyStatus = "down"
	DependencyStatusUnknown DependencyStatus = "unknown"
)

func (DependencyStatus) AllValues 

func (DependencyStatus) AllValues() []DependencyStatus

AllValues returns all DependencyStatus values.

func (*DependencyStatus) Decode 

func (s *DependencyStatus) Decode(d *jx.Decoder) error

Decode decodes DependencyStatus from json.

func (DependencyStatus) Encode 

func (s DependencyStatus) Encode(e *jx.Encoder)

Encode encodes DependencyStatus as json.

func (DependencyStatus) MarshalJSON 

func (s DependencyStatus) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (DependencyStatus) MarshalText 

func (s DependencyStatus) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*DependencyStatus) UnmarshalJSON 

func (s *DependencyStatus) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*DependencyStatus) UnmarshalText 

func (s *DependencyStatus) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (DependencyStatus) Validate 

func (s DependencyStatus) Validate() error

type ErrorHandler 

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type ForbiddenError 

type ForbiddenError struct {
	// The error message.
	Error string `json:"error"`
}

Ref: #/components/schemas/ForbiddenError

func (*ForbiddenError) Decode 

func (s *ForbiddenError) Decode(d *jx.Decoder) error

Decode decodes ForbiddenError from json.

func (*ForbiddenError) Encode 

func (s *ForbiddenError) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*ForbiddenError) GetError 

func (s *ForbiddenError) GetError() string

GetError returns the value of Error.

func (*ForbiddenError) MarshalJSON 

func (s *ForbiddenError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ForbiddenError) SetError 

func (s *ForbiddenError) SetError(val string)

SetError sets the value of Error.

func (*ForbiddenError) UnmarshalJSON 

func (s *ForbiddenError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type GetPublicKeyParams 

type GetPublicKeyParams struct {
	// The unique identifier of the key, conveyed through its KID field.
	Kid KID
}

GetPublicKeyParams is parameters of getPublicKey operation.

type GetPublicKeyRes 

type GetPublicKeyRes interface {
	// contains filtered or unexported methods
}

type Handler 

type Handler interface {
	// GetPublicKey implements getPublicKey operation.
	//
	// Get a public key from its usage.
	//
	// GET /public-keys
	GetPublicKey(ctx context.Context, params GetPublicKeyParams) (GetPublicKeyRes, error)
	// Healthcheck implements healthcheck operation.
	//
	// Returns a detailed report of the health of the service, including every dependency.
	//
	// GET /healthcheck
	Healthcheck(ctx context.Context) (HealthcheckRes, error)
	// ListPublicKeys implements listPublicKeys operation.
	//
	// Get all public keys from the service that match a given usage.
	//
	// GET /public-keys/list
	ListPublicKeys(ctx context.Context, params ListPublicKeysParams) (ListPublicKeysRes, error)
	// Ping implements ping operation.
	//
	// Check the status of the service. If the service is running, a successful response is returned.
	//
	// GET /ping
	Ping(ctx context.Context) (PingRes, error)
	// SignClaims implements signClaims operation.
	//
	// Sign a payload using the configuration for the target usage.
	//
	// POST /payload/sign
	SignClaims(ctx context.Context, req SignClaimsReq, params SignClaimsParams) (SignClaimsRes, error)
	// NewError creates *UnexpectedErrorStatusCode from error returned by handler.
	//
	// Used for common default response.
	NewError(ctx context.Context, err error) *UnexpectedErrorStatusCode
}

Handler handles operations described by OpenAPI v3 specification.

type Health 

type Health struct {
	Postgres Dependency `json:"postgres"`
}

Ref: #/components/schemas/Health

func (*Health) Decode 

func (s *Health) Decode(d *jx.Decoder) error

Decode decodes Health from json.

func (*Health) Encode 

func (s *Health) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*Health) GetPostgres 

func (s *Health) GetPostgres() Dependency

GetPostgres returns the value of Postgres.

func (*Health) MarshalJSON 

func (s *Health) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Health) SetPostgres 

func (s *Health) SetPostgres(val Dependency)

SetPostgres sets the value of Postgres.

func (*Health) UnmarshalJSON 

func (s *Health) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*Health) Validate 

func (s *Health) Validate() error

type HealthcheckIMATeapot 

type HealthcheckIMATeapot struct{}

HealthcheckIMATeapot is response for Healthcheck operation.

type HealthcheckRes 

type HealthcheckRes interface {
	// contains filtered or unexported methods
}

type Invoker 

type Invoker interface {
	// GetPublicKey invokes getPublicKey operation.
	//
	// Get a public key from its usage.
	//
	// GET /public-keys
	GetPublicKey(ctx context.Context, params GetPublicKeyParams) (GetPublicKeyRes, error)
	// Healthcheck invokes healthcheck operation.
	//
	// Returns a detailed report of the health of the service, including every dependency.
	//
	// GET /healthcheck
	Healthcheck(ctx context.Context) (HealthcheckRes, error)
	// ListPublicKeys invokes listPublicKeys operation.
	//
	// Get all public keys from the service that match a given usage.
	//
	// GET /public-keys/list
	ListPublicKeys(ctx context.Context, params ListPublicKeysParams) (ListPublicKeysRes, error)
	// Ping invokes ping operation.
	//
	// Check the status of the service. If the service is running, a successful response is returned.
	//
	// GET /ping
	Ping(ctx context.Context) (PingRes, error)
	// SignClaims invokes signClaims operation.
	//
	// Sign a payload using the configuration for the target usage.
	//
	// POST /payload/sign
	SignClaims(ctx context.Context, request SignClaimsReq, params SignClaimsParams) (SignClaimsRes, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

type JWK 

type JWK struct {
	Kty             KTY     `json:"kty"`
	Use             Use     `json:"use"`
	KeyOps          []KeyOp `json:"key_ops"`
	Alg             Alg     `json:"alg"`
	Kid             OptKID  `json:"kid"`
	AdditionalProps JWKAdditional
}

Ref: #/components/schemas/JWK

func (*JWK) Decode 

func (s *JWK) Decode(d *jx.Decoder) error

Decode decodes JWK from json.

func (*JWK) Encode 

func (s *JWK) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*JWK) GetAdditionalProps 

func (s *JWK) GetAdditionalProps() JWKAdditional

GetAdditionalProps returns the value of AdditionalProps.

func (*JWK) GetAlg 

func (s *JWK) GetAlg() Alg

GetAlg returns the value of Alg.

func (*JWK) GetKeyOps 

func (s *JWK) GetKeyOps() []KeyOp

GetKeyOps returns the value of KeyOps.

func (*JWK) GetKid 

func (s *JWK) GetKid() OptKID

GetKid returns the value of Kid.

func (*JWK) GetKty 

func (s *JWK) GetKty() KTY

GetKty returns the value of Kty.

func (*JWK) GetUse 

func (s *JWK) GetUse() Use

GetUse returns the value of Use.

func (*JWK) MarshalJSON 

func (s *JWK) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*JWK) SetAdditionalProps 

func (s *JWK) SetAdditionalProps(val JWKAdditional)

SetAdditionalProps sets the value of AdditionalProps.

func (*JWK) SetAlg 

func (s *JWK) SetAlg(val Alg)

SetAlg sets the value of Alg.

func (*JWK) SetKeyOps 

func (s *JWK) SetKeyOps(val []KeyOp)

SetKeyOps sets the value of KeyOps.

func (*JWK) SetKid 

func (s *JWK) SetKid(val OptKID)

SetKid sets the value of Kid.

func (*JWK) SetKty 

func (s *JWK) SetKty(val KTY)

SetKty sets the value of Kty.

func (*JWK) SetUse 

func (s *JWK) SetUse(val Use)

SetUse sets the value of Use.

func (*JWK) UnmarshalJSON 

func (s *JWK) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*JWK) Validate 

func (s *JWK) Validate() error

type JWKAdditional 

type JWKAdditional map[string]jx.Raw

func (*JWKAdditional) Decode 

func (s *JWKAdditional) Decode(d *jx.Decoder) error

Decode decodes JWKAdditional from json.

func (JWKAdditional) Encode 

func (s JWKAdditional) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (JWKAdditional) MarshalJSON 

func (s JWKAdditional) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*JWKAdditional) UnmarshalJSON 

func (s *JWKAdditional) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type KID 

type KID uuid.UUID

func (*KID) Decode 

func (s *KID) Decode(d *jx.Decoder) error

Decode decodes KID from json.

func (KID) Encode 

func (s KID) Encode(e *jx.Encoder)

Encode encodes KID as json.

func (KID) MarshalJSON 

func (s KID) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*KID) UnmarshalJSON 

func (s *KID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type KTY 

type KTY string

The type of the key embedded in the JWK. Ref: #/components/schemas/KTY 

const (
	KTYOct KTY = "oct"
	KTYRSA KTY = "RSA"
	KTYEC  KTY = "EC"
	KTYOKP KTY = "OKP"
)

func (KTY) AllValues 

func (KTY) AllValues() []KTY

AllValues returns all KTY values.

func (*KTY) Decode 

func (s *KTY) Decode(d *jx.Decoder) error

Decode decodes KTY from json.

func (KTY) Encode 

func (s KTY) Encode(e *jx.Encoder)

Encode encodes KTY as json.

func (KTY) MarshalJSON 

func (s KTY) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (KTY) MarshalText 

func (s KTY) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*KTY) UnmarshalJSON 

func (s *KTY) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*KTY) UnmarshalText 

func (s *KTY) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (KTY) Validate 

func (s KTY) Validate() error

type KeyOp 

type KeyOp string

The operation that can be performed using the key. Ref: #/components/schemas/KeyOp 

const (
	KeyOpSign       KeyOp = "sign"
	KeyOpVerify     KeyOp = "verify"
	KeyOpEncrypt    KeyOp = "encrypt"
	KeyOpDecrypt    KeyOp = "decrypt"
	KeyOpWrapKey    KeyOp = "wrapKey"
	KeyOpUnwrapKey  KeyOp = "unwrapKey"
	KeyOpDeriveKey  KeyOp = "deriveKey"
	KeyOpDeriveBits KeyOp = "deriveBits"
)

func (KeyOp) AllValues 

func (KeyOp) AllValues() []KeyOp

AllValues returns all KeyOp values.

func (*KeyOp) Decode 

func (s *KeyOp) Decode(d *jx.Decoder) error

Decode decodes KeyOp from json.

func (KeyOp) Encode 

func (s KeyOp) Encode(e *jx.Encoder)

Encode encodes KeyOp as json.

func (KeyOp) MarshalJSON 

func (s KeyOp) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (KeyOp) MarshalText 

func (s KeyOp) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*KeyOp) UnmarshalJSON 

func (s *KeyOp) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*KeyOp) UnmarshalText 

func (s *KeyOp) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (KeyOp) Validate 

func (s KeyOp) Validate() error

type KeyUsage 

type KeyUsage string

The intended usage of the key. Ref: #/components/schemas/KeyUsage 

const (
	KeyUsageAuth    KeyUsage = "auth"
	KeyUsageRefresh KeyUsage = "refresh"
)

func (KeyUsage) AllValues 

func (KeyUsage) AllValues() []KeyUsage

AllValues returns all KeyUsage values.

func (KeyUsage) MarshalText 

func (s KeyUsage) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*KeyUsage) UnmarshalText 

func (s *KeyUsage) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (KeyUsage) Validate 

func (s KeyUsage) Validate() error

type Labeler 

type Labeler struct {
	// contains filtered or unexported fields
}

Labeler is used to allow adding custom attributes to the server request metrics.

func LabelerFromContext 

func LabelerFromContext(ctx context.Context) (*Labeler, bool)

LabelerFromContext retrieves the Labeler from the provided context, if present.

If no Labeler was found in the provided context a new, empty Labeler is returned and the second return value is false. In this case it is safe to use the Labeler but any attributes added to it will not be used.

func (*Labeler) Add 

func (l *Labeler) Add(attrs ...attribute.KeyValue)

Add attributes to the Labeler.

func (*Labeler) AttributeSet 

func (l *Labeler) AttributeSet() attribute.Set

AttributeSet returns the attributes added to the Labeler as an attribute.Set.

type ListPublicKeysOKApplicationJSON 

type ListPublicKeysOKApplicationJSON []JWK

func (*ListPublicKeysOKApplicationJSON) Decode 

func (s *ListPublicKeysOKApplicationJSON) Decode(d *jx.Decoder) error

Decode decodes ListPublicKeysOKApplicationJSON from json.

func (ListPublicKeysOKApplicationJSON) Encode 

func (s ListPublicKeysOKApplicationJSON) Encode(e *jx.Encoder)

Encode encodes ListPublicKeysOKApplicationJSON as json.

func (ListPublicKeysOKApplicationJSON) MarshalJSON 

func (s ListPublicKeysOKApplicationJSON) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*ListPublicKeysOKApplicationJSON) UnmarshalJSON 

func (s *ListPublicKeysOKApplicationJSON) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (ListPublicKeysOKApplicationJSON) Validate 

func (s ListPublicKeysOKApplicationJSON) Validate() error

type ListPublicKeysParams 

type ListPublicKeysParams struct {
	// The intended usage of the keys.
	Usage KeyUsage
}

ListPublicKeysParams is parameters of listPublicKeys operation.

type ListPublicKeysRes 

type ListPublicKeysRes interface {
	// contains filtered or unexported methods
}

type Middleware 

type Middleware = middleware.Middleware

Middleware is middleware type.

type NotFoundError 

type NotFoundError struct {
	// The error message.
	Error string `json:"error"`
}

Ref: #/components/schemas/NotFoundError

func (*NotFoundError) Decode 

func (s *NotFoundError) Decode(d *jx.Decoder) error

Decode decodes NotFoundError from json.

func (*NotFoundError) Encode 

func (s *NotFoundError) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*NotFoundError) GetError 

func (s *NotFoundError) GetError() string

GetError returns the value of Error.

func (*NotFoundError) MarshalJSON 

func (s *NotFoundError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*NotFoundError) SetError 

func (s *NotFoundError) SetError(val string)

SetError sets the value of Error.

func (*NotFoundError) UnmarshalJSON 

func (s *NotFoundError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type OperationName 

type OperationName = string

OperationName is the ogen operation name 

const (
	GetPublicKeyOperation   OperationName = "GetPublicKey"
	HealthcheckOperation    OperationName = "Healthcheck"
	ListPublicKeysOperation OperationName = "ListPublicKeys"
	PingOperation           OperationName = "Ping"
	SignClaimsOperation     OperationName = "SignClaims"
)

type OptKID 

type OptKID struct {
	Value KID
	Set   bool
}

OptKID is optional KID.

func NewOptKID 

func NewOptKID(v KID) OptKID

NewOptKID returns new OptKID with value set to v.

func (*OptKID) Decode 

func (o *OptKID) Decode(d *jx.Decoder) error

Decode decodes KID from json.

func (OptKID) Encode 

func (o OptKID) Encode(e *jx.Encoder)

Encode encodes KID as json.

func (OptKID) Get 

func (o OptKID) Get() (v KID, ok bool)

Get returns value and boolean that denotes whether value was set.

func (OptKID) IsSet 

func (o OptKID) IsSet() bool

IsSet returns true if OptKID was set.

func (OptKID) MarshalJSON 

func (s OptKID) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (OptKID) Or 

func (o OptKID) Or(d KID) KID

Or returns value if set, or given parameter if does not.

func (*OptKID) Reset 

func (o *OptKID) Reset()

Reset unsets value.

func (*OptKID) SetTo 

func (o *OptKID) SetTo(v KID)

SetTo sets value to v.

func (*OptKID) UnmarshalJSON 

func (s *OptKID) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type Option 

type Option interface {
	ServerOption
	ClientOption
}

Option is config option.

func WithAttributes added in v1.3.9 

func WithAttributes(attributes ...attribute.KeyValue) Option

WithAttributes specifies default otel attributes.

func WithMeterProvider 

func WithMeterProvider(provider metric.MeterProvider) Option

WithMeterProvider specifies a meter provider to use for creating a meter.

If none is specified, the otel.GetMeterProvider() is used.

func WithTracerProvider 

func WithTracerProvider(provider trace.TracerProvider) Option

WithTracerProvider specifies a tracer provider to use for creating a tracer.

If none is specified, the global provider is used.

type PingIMATeapot 

type PingIMATeapot struct{}

PingIMATeapot is response for Ping operation.

type PingOK 

type PingOK struct {
	Data io.Reader
}

func (PingOK) Read 

func (s PingOK) Read(p []byte) (n int, err error)

Read reads data from the Data reader.

Kept to satisfy the io.Reader interface.

type PingRes 

type PingRes interface {
	// contains filtered or unexported methods
}

type Route 

type Route struct {
	// contains filtered or unexported fields
}

Route is route object.

func (Route) Args 

func (r Route) Args() []string

Args returns parsed arguments.

func (Route) Name 

func (r Route) Name() string

Name returns ogen operation name.

It is guaranteed to be unique and not empty.

func (Route) OperationID 

func (r Route) OperationID() string

OperationID returns OpenAPI operationId.

func (Route) PathPattern 

func (r Route) PathPattern() string

PathPattern returns OpenAPI path.

func (Route) Summary 

func (r Route) Summary() string

Summary returns OpenAPI summary.

type Server 

type Server struct {
	// contains filtered or unexported fields
}

Server implements http server based on OpenAPI v3 specification and calls Handler to handle requests.

func NewServer 

func NewServer(h Handler, opts ...ServerOption) (*Server, error)

NewServer creates new Server.

func (*Server) FindPath 

func (s *Server) FindPath(method string, u *url.URL) (r Route, _ bool)

FindPath finds Route for given method and URL.

func (*Server) FindRoute 

func (s *Server) FindRoute(method, path string) (Route, bool)

FindRoute finds Route for given method and path.

Note: this method does not unescape path or handle reserved characters in path properly. Use FindPath instead.

func (*Server) ServeHTTP 

func (s *Server) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP serves http request as defined by OpenAPI v3 specification, calling handler that matches the path or returning not found error.

type ServerOption 

type ServerOption interface {
	// contains filtered or unexported methods
}

ServerOption is server config option.

func WithErrorHandler 

func WithErrorHandler(h ErrorHandler) ServerOption

WithErrorHandler specifies error handler to use.

func WithMaxMultipartMemory 

func WithMaxMultipartMemory(max int64) ServerOption

WithMaxMultipartMemory specifies limit of memory for storing file parts. File parts which can't be stored in memory will be stored on disk in temporary files.

func WithMethodNotAllowed 

func WithMethodNotAllowed(methodNotAllowed func(w http.ResponseWriter, r *http.Request, allowed string)) ServerOption

WithMethodNotAllowed specifies Method Not Allowed handler to use.

func WithMiddleware 

func WithMiddleware(m ...Middleware) ServerOption

WithMiddleware specifies middlewares to use.

func WithNotFound 

func WithNotFound(notFound http.HandlerFunc) ServerOption

WithNotFound specifies Not Found handler to use.

func WithPathPrefix 

func WithPathPrefix(prefix string) ServerOption

WithPathPrefix specifies server path prefix.

type SignClaimsParams 

type SignClaimsParams struct {
	// The intended usage of the keys.
	Usage KeyUsage
}

SignClaimsParams is parameters of signClaims operation.

type SignClaimsReq 

type SignClaimsReq map[string]jx.Raw

The claims to be signed. The structure of the claims depends on the intended usage of the key. For example, for authentication, it may include user ID, roles, and expiration time.

func (*SignClaimsReq) Decode 

func (s *SignClaimsReq) Decode(d *jx.Decoder) error

Decode decodes SignClaimsReq from json.

func (SignClaimsReq) Encode 

func (s SignClaimsReq) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (SignClaimsReq) MarshalJSON 

func (s SignClaimsReq) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*SignClaimsReq) UnmarshalJSON 

func (s *SignClaimsReq) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type SignClaimsRes 

type SignClaimsRes interface {
	// contains filtered or unexported methods
}

type Token 

type Token struct {
	// The signed token.
	Token string `json:"token"`
}

Ref: #/components/schemas/Token

func (*Token) Decode 

func (s *Token) Decode(d *jx.Decoder) error

Decode decodes Token from json.

func (*Token) Encode 

func (s *Token) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*Token) GetToken 

func (s *Token) GetToken() string

GetToken returns the value of Token.

func (*Token) MarshalJSON 

func (s *Token) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*Token) SetToken 

func (s *Token) SetToken(val string)

SetToken sets the value of Token.

func (*Token) UnmarshalJSON 

func (s *Token) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type UnauthorizedError 

type UnauthorizedError struct {
	// The error message.
	Error string `json:"error"`
}

Ref: #/components/schemas/UnauthorizedError

func (*UnauthorizedError) Decode 

func (s *UnauthorizedError) Decode(d *jx.Decoder) error

Decode decodes UnauthorizedError from json.

func (*UnauthorizedError) Encode 

func (s *UnauthorizedError) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UnauthorizedError) GetError 

func (s *UnauthorizedError) GetError() string

GetError returns the value of Error.

func (*UnauthorizedError) MarshalJSON 

func (s *UnauthorizedError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UnauthorizedError) SetError 

func (s *UnauthorizedError) SetError(val string)

SetError sets the value of Error.

func (*UnauthorizedError) UnmarshalJSON 

func (s *UnauthorizedError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type UnexpectedError 

type UnexpectedError struct {
	// The error message.
	Error string `json:"error"`
}

Ref: #/components/schemas/UnexpectedError

func (*UnexpectedError) Decode 

func (s *UnexpectedError) Decode(d *jx.Decoder) error

Decode decodes UnexpectedError from json.

func (*UnexpectedError) Encode 

func (s *UnexpectedError) Encode(e *jx.Encoder)

Encode implements json.Marshaler.

func (*UnexpectedError) GetError 

func (s *UnexpectedError) GetError() string

GetError returns the value of Error.

func (*UnexpectedError) MarshalJSON 

func (s *UnexpectedError) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (*UnexpectedError) SetError 

func (s *UnexpectedError) SetError(val string)

SetError sets the value of Error.

func (*UnexpectedError) UnmarshalJSON 

func (s *UnexpectedError) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

type UnexpectedErrorStatusCode 

type UnexpectedErrorStatusCode struct {
	StatusCode int
	Response   UnexpectedError
}

UnexpectedErrorStatusCode wraps UnexpectedError with StatusCode.

func (*UnexpectedErrorStatusCode) Error 

func (s *UnexpectedErrorStatusCode) Error() string

func (*UnexpectedErrorStatusCode) GetResponse 

func (s *UnexpectedErrorStatusCode) GetResponse() UnexpectedError

GetResponse returns the value of Response.

func (*UnexpectedErrorStatusCode) GetStatusCode 

func (s *UnexpectedErrorStatusCode) GetStatusCode() int

GetStatusCode returns the value of StatusCode.

func (*UnexpectedErrorStatusCode) SetResponse 

func (s *UnexpectedErrorStatusCode) SetResponse(val UnexpectedError)

SetResponse sets the value of Response.

func (*UnexpectedErrorStatusCode) SetStatusCode 

func (s *UnexpectedErrorStatusCode) SetStatusCode(val int)

SetStatusCode sets the value of StatusCode.

type UnimplementedHandler 

type UnimplementedHandler struct{}

UnimplementedHandler is no-op Handler which returns http.ErrNotImplemented.

func (UnimplementedHandler) GetPublicKey 

func (UnimplementedHandler) GetPublicKey(ctx context.Context, params GetPublicKeyParams) (r GetPublicKeyRes, _ error)

GetPublicKey implements getPublicKey operation.

Get a public key from its usage.

GET /public-keys

func (UnimplementedHandler) Healthcheck 

func (UnimplementedHandler) Healthcheck(ctx context.Context) (r HealthcheckRes, _ error)

Healthcheck implements healthcheck operation.

Returns a detailed report of the health of the service, including every dependency.

GET /healthcheck

func (UnimplementedHandler) ListPublicKeys 

func (UnimplementedHandler) ListPublicKeys(ctx context.Context, params ListPublicKeysParams) (r ListPublicKeysRes, _ error)

ListPublicKeys implements listPublicKeys operation.

Get all public keys from the service that match a given usage.

GET /public-keys/list

func (UnimplementedHandler) NewError 

func (UnimplementedHandler) NewError(ctx context.Context, err error) (r *UnexpectedErrorStatusCode)

NewError creates *UnexpectedErrorStatusCode from error returned by handler.

Used for common default response.

func (UnimplementedHandler) Ping 

func (UnimplementedHandler) Ping(ctx context.Context) (r PingRes, _ error)

Ping implements ping operation.

Check the status of the service. If the service is running, a successful response is returned.

GET /ping

func (UnimplementedHandler) SignClaims 

func (UnimplementedHandler) SignClaims(ctx context.Context, req SignClaimsReq, params SignClaimsParams) (r SignClaimsRes, _ error)

SignClaims implements signClaims operation.

Sign a payload using the configuration for the target usage.

POST /payload/sign

type Use 

type Use string

The intended use of the public key. Ref: #/components/schemas/Use 

const (
	UseSig Use = "sig"
	UseEnc Use = "enc"
)

func (Use) AllValues 

func (Use) AllValues() []Use

AllValues returns all Use values.

func (*Use) Decode 

func (s *Use) Decode(d *jx.Decoder) error

Decode decodes Use from json.

func (Use) Encode 

func (s Use) Encode(e *jx.Encoder)

Encode encodes Use as json.

func (Use) MarshalJSON 

func (s Use) MarshalJSON() ([]byte, error)

MarshalJSON implements stdjson.Marshaler.

func (Use) MarshalText 

func (s Use) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (*Use) UnmarshalJSON 

func (s *Use) UnmarshalJSON(data []byte) error

UnmarshalJSON implements stdjson.Unmarshaler.

func (*Use) UnmarshalText 

func (s *Use) UnmarshalText(data []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

func (Use) Validate 

func (s Use) Validate() error

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.