senzingchatapi

package
v0.3.2 Latest Latest
Warning

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

Go to latest
Published: Oct 30, 2024 License: Apache-2.0 Imports: 27 Imported by: 0

Documentation

Overview

Package senzingchatapi is code generate by ogen.

ogen is an OpenAPI v3 code generator for Go.

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 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) EntityDetailsEntityDetailsGet

func (c *Client) EntityDetailsEntityDetailsGet(ctx context.Context, params EntityDetailsEntityDetailsGetParams) (EntityDetailsEntityDetailsGetRes, error)

EntityDetailsEntityDetailsGet invokes entity_details_entity_details_get operation.

Retrieve entity data based on the ID of a resolved identity.

GET /entity_details

func (*Client) EntityHowEntityHowGet

func (c *Client) EntityHowEntityHowGet(ctx context.Context, params EntityHowEntityHowGetParams) (EntityHowEntityHowGetRes, error)

EntityHowEntityHowGet invokes entity_how_entity_how_get operation.

Determines and details steps-by-step how records resolved to an ENTITY_ID.

GET /entity_how

func (*Client) EntityReportEntityReportGet

func (c *Client) EntityReportEntityReportGet(ctx context.Context, params EntityReportEntityReportGetParams) (EntityReportEntityReportGetRes, error)

EntityReportEntityReportGet invokes entity_report_entity_report_get operation.

Return 10 entities with either matches, possible matches, or relationships.

GET /entity_report

func (*Client) EntitySearchEntitySearchPost

func (c *Client) EntitySearchEntitySearchPost(ctx context.Context, request *SearchAttributes) (EntitySearchEntitySearchPostRes, error)

EntitySearchEntitySearchPost invokes entity_search_entity_search_post operation.

Retrieves entity data based on a user-specified set of entity attributes.

POST /entity_search

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 EntityDetailsEntityDetailsGetOK

type EntityDetailsEntityDetailsGetOK struct{}

func (*EntityDetailsEntityDetailsGetOK) Decode

Decode decodes EntityDetailsEntityDetailsGetOK from json.

func (*EntityDetailsEntityDetailsGetOK) Encode

Encode implements json.Marshaler.

func (*EntityDetailsEntityDetailsGetOK) MarshalJSON

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

MarshalJSON implements stdjson.Marshaler.

func (*EntityDetailsEntityDetailsGetOK) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

type EntityDetailsEntityDetailsGetParams

type EntityDetailsEntityDetailsGetParams struct {
	EntityID int
}

EntityDetailsEntityDetailsGetParams is parameters of entity_details_entity_details_get operation.

type EntityDetailsEntityDetailsGetRes

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

type EntityHowEntityHowGetOK

type EntityHowEntityHowGetOK struct{}

func (*EntityHowEntityHowGetOK) Decode

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

Decode decodes EntityHowEntityHowGetOK from json.

func (*EntityHowEntityHowGetOK) Encode

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

Encode implements json.Marshaler.

func (*EntityHowEntityHowGetOK) MarshalJSON

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

MarshalJSON implements stdjson.Marshaler.

func (*EntityHowEntityHowGetOK) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

type EntityHowEntityHowGetParams

type EntityHowEntityHowGetParams struct {
	EntityID int
}

EntityHowEntityHowGetParams is parameters of entity_how_entity_how_get operation.

type EntityHowEntityHowGetRes

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

type EntityReportEntityReportGetOKApplicationJSON

type EntityReportEntityReportGetOKApplicationJSON []jx.Raw

func (*EntityReportEntityReportGetOKApplicationJSON) Decode

Decode decodes EntityReportEntityReportGetOKApplicationJSON from json.

func (EntityReportEntityReportGetOKApplicationJSON) Encode

Encode encodes EntityReportEntityReportGetOKApplicationJSON as json.

func (EntityReportEntityReportGetOKApplicationJSON) MarshalJSON

MarshalJSON implements stdjson.Marshaler.

func (*EntityReportEntityReportGetOKApplicationJSON) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (EntityReportEntityReportGetOKApplicationJSON) Validate

type EntityReportEntityReportGetParams

type EntityReportEntityReportGetParams struct {
	ExportFlags ExportFlags
}

EntityReportEntityReportGetParams is parameters of entity_report_entity_report_get operation.

type EntityReportEntityReportGetRes

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

type EntitySearchEntitySearchPostOK

type EntitySearchEntitySearchPostOK struct{}

func (*EntitySearchEntitySearchPostOK) Decode

Decode decodes EntitySearchEntitySearchPostOK from json.

func (*EntitySearchEntitySearchPostOK) Encode

Encode implements json.Marshaler.

func (*EntitySearchEntitySearchPostOK) MarshalJSON

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

MarshalJSON implements stdjson.Marshaler.

func (*EntitySearchEntitySearchPostOK) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

type EntitySearchEntitySearchPostRes

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

type ErrorHandler

type ErrorHandler = ogenerrors.ErrorHandler

ErrorHandler is error handler.

type ExportFlags

type ExportFlags string

An enumeration. Ref: #/components/schemas/ExportFlags

const (
	ExportFlagsMATCHED               ExportFlags = "MATCHED"
	ExportFlagsPOSSIBLEMATCHES       ExportFlags = "POSSIBLE_MATCHES"
	ExportFlagsPOSSIBLERELATIONSHIPS ExportFlags = "POSSIBLE_RELATIONSHIPS"
)

func (ExportFlags) AllValues added in v0.2.2

func (ExportFlags) AllValues() []ExportFlags

AllValues returns all ExportFlags values.

func (ExportFlags) MarshalText

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

MarshalText implements encoding.TextMarshaler.

func (*ExportFlags) UnmarshalText

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

UnmarshalText implements encoding.TextUnmarshaler.

func (ExportFlags) Validate

func (s ExportFlags) Validate() error

type HTTPValidationError

type HTTPValidationError struct {
	Detail []ValidationError `json:"detail"`
}

Ref: #/components/schemas/HTTPValidationError

func (*HTTPValidationError) Decode

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

Decode decodes HTTPValidationError from json.

func (*HTTPValidationError) Encode

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

Encode implements json.Marshaler.

func (*HTTPValidationError) GetDetail

func (s *HTTPValidationError) GetDetail() []ValidationError

GetDetail returns the value of Detail.

func (*HTTPValidationError) MarshalJSON

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

MarshalJSON implements stdjson.Marshaler.

func (*HTTPValidationError) SetDetail

func (s *HTTPValidationError) SetDetail(val []ValidationError)

SetDetail sets the value of Detail.

func (*HTTPValidationError) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (*HTTPValidationError) Validate

func (s *HTTPValidationError) Validate() error

type Handler

type Handler interface {
	// EntityDetailsEntityDetailsGet implements entity_details_entity_details_get operation.
	//
	// Retrieve entity data based on the ID of a resolved identity.
	//
	// GET /entity_details
	EntityDetailsEntityDetailsGet(ctx context.Context, params EntityDetailsEntityDetailsGetParams) (EntityDetailsEntityDetailsGetRes, error)
	// EntityHowEntityHowGet implements entity_how_entity_how_get operation.
	//
	// Determines and details steps-by-step how records resolved to an ENTITY_ID.
	//
	// GET /entity_how
	EntityHowEntityHowGet(ctx context.Context, params EntityHowEntityHowGetParams) (EntityHowEntityHowGetRes, error)
	// EntityReportEntityReportGet implements entity_report_entity_report_get operation.
	//
	// Return 10 entities with either matches, possible matches, or relationships.
	//
	// GET /entity_report
	EntityReportEntityReportGet(ctx context.Context, params EntityReportEntityReportGetParams) (EntityReportEntityReportGetRes, error)
	// EntitySearchEntitySearchPost implements entity_search_entity_search_post operation.
	//
	// Retrieves entity data based on a user-specified set of entity attributes.
	//
	// POST /entity_search
	EntitySearchEntitySearchPost(ctx context.Context, req *SearchAttributes) (EntitySearchEntitySearchPostRes, error)
}

Handler handles operations described by OpenAPI v3 specification.

type Invoker added in v0.2.2

type Invoker interface {
	// EntityDetailsEntityDetailsGet invokes entity_details_entity_details_get operation.
	//
	// Retrieve entity data based on the ID of a resolved identity.
	//
	// GET /entity_details
	EntityDetailsEntityDetailsGet(ctx context.Context, params EntityDetailsEntityDetailsGetParams) (EntityDetailsEntityDetailsGetRes, error)
	// EntityHowEntityHowGet invokes entity_how_entity_how_get operation.
	//
	// Determines and details steps-by-step how records resolved to an ENTITY_ID.
	//
	// GET /entity_how
	EntityHowEntityHowGet(ctx context.Context, params EntityHowEntityHowGetParams) (EntityHowEntityHowGetRes, error)
	// EntityReportEntityReportGet invokes entity_report_entity_report_get operation.
	//
	// Return 10 entities with either matches, possible matches, or relationships.
	//
	// GET /entity_report
	EntityReportEntityReportGet(ctx context.Context, params EntityReportEntityReportGetParams) (EntityReportEntityReportGetRes, error)
	// EntitySearchEntitySearchPost invokes entity_search_entity_search_post operation.
	//
	// Retrieves entity data based on a user-specified set of entity attributes.
	//
	// POST /entity_search
	EntitySearchEntitySearchPost(ctx context.Context, request *SearchAttributes) (EntitySearchEntitySearchPostRes, error)
}

Invoker invokes operations described by OpenAPI v3 specification.

type Labeler added in v0.2.2

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

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

func LabelerFromContext added in v0.2.2

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 added in v0.2.2

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

Add attributes to the Labeler.

func (*Labeler) AttributeSet added in v0.2.2

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

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

type Middleware

type Middleware = middleware.Middleware

Middleware is middleware type.

type OptString

type OptString struct {
	Value string
	Set   bool
}

OptString is optional string.

func NewOptString

func NewOptString(v string) OptString

NewOptString returns new OptString with value set to v.

func (*OptString) Decode

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

Decode decodes string from json.

func (OptString) Encode

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

Encode encodes string as json.

func (OptString) Get

func (o OptString) Get() (v string, ok bool)

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

func (OptString) IsSet

func (o OptString) IsSet() bool

IsSet returns true if OptString was set.

func (OptString) MarshalJSON

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

MarshalJSON implements stdjson.Marshaler.

func (OptString) Or

func (o OptString) Or(d string) string

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

func (*OptString) Reset

func (o *OptString) Reset()

Reset unsets value.

func (*OptString) SetTo

func (o *OptString) SetTo(v string)

SetTo sets value to v.

func (*OptString) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

type Option

type Option interface {
	ServerOption
	ClientOption
}

Option is config option.

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 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 added in v0.2.2

func (r Route) Summary() string

Summary returns OpenAPI summary.

type SearchAttributes

type SearchAttributes struct {
	ADDRCITY             OptString `json:"ADDR_CITY"`
	ADDRCOUNTRY          OptString `json:"ADDR_COUNTRY"`
	ADDRFULL             OptString `json:"ADDR_FULL"`
	ADDRLINE1            OptString `json:"ADDR_LINE1"`
	ADDRPOSTALCODE       OptString `json:"ADDR_POSTAL_CODE"`
	ADDRSTATE            OptString `json:"ADDR_STATE"`
	DATEOFBIRTH          OptString `json:"DATE_OF_BIRTH"`
	DRIVERSLICENSENUMBER OptString `json:"DRIVERS_LICENSE_NUMBER"`
	EMAILADDRESS         OptString `json:"EMAIL_ADDRESS"`
	NAMEFIRST            OptString `json:"NAME_FIRST"`
	NAMEFULL             OptString `json:"NAME_FULL"`
	NAMELAST             OptString `json:"NAME_LAST"`
	NAMEMIDDLE           OptString `json:"NAME_MIDDLE"`
	NAMEORG              OptString `json:"NAME_ORG"`
	NAMESUFFIX           OptString `json:"NAME_SUFFIX"`
	NATIONALIDNUMBER     OptString `json:"NATIONAL_ID_NUMBER"`
	PASSPORTCOUNTRY      OptString `json:"PASSPORT_COUNTRY"`
	PASSPORTNUMBER       OptString `json:"PASSPORT_NUMBER"`
	PHONENUMBER          OptString `json:"PHONE_NUMBER"`
	SSNNUMBER            OptString `json:"SSN_NUMBER"`
}

Ref: #/components/schemas/SearchAttributes

func (*SearchAttributes) Decode

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

Decode decodes SearchAttributes from json.

func (*SearchAttributes) Encode

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

Encode implements json.Marshaler.

func (*SearchAttributes) GetADDRCITY

func (s *SearchAttributes) GetADDRCITY() OptString

GetADDRCITY returns the value of ADDRCITY.

func (*SearchAttributes) GetADDRCOUNTRY

func (s *SearchAttributes) GetADDRCOUNTRY() OptString

GetADDRCOUNTRY returns the value of ADDRCOUNTRY.

func (*SearchAttributes) GetADDRFULL

func (s *SearchAttributes) GetADDRFULL() OptString

GetADDRFULL returns the value of ADDRFULL.

func (*SearchAttributes) GetADDRLINE1

func (s *SearchAttributes) GetADDRLINE1() OptString

GetADDRLINE1 returns the value of ADDRLINE1.

func (*SearchAttributes) GetADDRPOSTALCODE

func (s *SearchAttributes) GetADDRPOSTALCODE() OptString

GetADDRPOSTALCODE returns the value of ADDRPOSTALCODE.

func (*SearchAttributes) GetADDRSTATE

func (s *SearchAttributes) GetADDRSTATE() OptString

GetADDRSTATE returns the value of ADDRSTATE.

func (*SearchAttributes) GetDATEOFBIRTH

func (s *SearchAttributes) GetDATEOFBIRTH() OptString

GetDATEOFBIRTH returns the value of DATEOFBIRTH.

func (*SearchAttributes) GetDRIVERSLICENSENUMBER

func (s *SearchAttributes) GetDRIVERSLICENSENUMBER() OptString

GetDRIVERSLICENSENUMBER returns the value of DRIVERSLICENSENUMBER.

func (*SearchAttributes) GetEMAILADDRESS

func (s *SearchAttributes) GetEMAILADDRESS() OptString

GetEMAILADDRESS returns the value of EMAILADDRESS.

func (*SearchAttributes) GetNAMEFIRST

func (s *SearchAttributes) GetNAMEFIRST() OptString

GetNAMEFIRST returns the value of NAMEFIRST.

func (*SearchAttributes) GetNAMEFULL

func (s *SearchAttributes) GetNAMEFULL() OptString

GetNAMEFULL returns the value of NAMEFULL.

func (*SearchAttributes) GetNAMELAST

func (s *SearchAttributes) GetNAMELAST() OptString

GetNAMELAST returns the value of NAMELAST.

func (*SearchAttributes) GetNAMEMIDDLE

func (s *SearchAttributes) GetNAMEMIDDLE() OptString

GetNAMEMIDDLE returns the value of NAMEMIDDLE.

func (*SearchAttributes) GetNAMEORG

func (s *SearchAttributes) GetNAMEORG() OptString

GetNAMEORG returns the value of NAMEORG.

func (*SearchAttributes) GetNAMESUFFIX

func (s *SearchAttributes) GetNAMESUFFIX() OptString

GetNAMESUFFIX returns the value of NAMESUFFIX.

func (*SearchAttributes) GetNATIONALIDNUMBER

func (s *SearchAttributes) GetNATIONALIDNUMBER() OptString

GetNATIONALIDNUMBER returns the value of NATIONALIDNUMBER.

func (*SearchAttributes) GetPASSPORTCOUNTRY

func (s *SearchAttributes) GetPASSPORTCOUNTRY() OptString

GetPASSPORTCOUNTRY returns the value of PASSPORTCOUNTRY.

func (*SearchAttributes) GetPASSPORTNUMBER

func (s *SearchAttributes) GetPASSPORTNUMBER() OptString

GetPASSPORTNUMBER returns the value of PASSPORTNUMBER.

func (*SearchAttributes) GetPHONENUMBER

func (s *SearchAttributes) GetPHONENUMBER() OptString

GetPHONENUMBER returns the value of PHONENUMBER.

func (*SearchAttributes) GetSSNNUMBER

func (s *SearchAttributes) GetSSNNUMBER() OptString

GetSSNNUMBER returns the value of SSNNUMBER.

func (*SearchAttributes) MarshalJSON

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

MarshalJSON implements stdjson.Marshaler.

func (*SearchAttributes) SetADDRCITY

func (s *SearchAttributes) SetADDRCITY(val OptString)

SetADDRCITY sets the value of ADDRCITY.

func (*SearchAttributes) SetADDRCOUNTRY

func (s *SearchAttributes) SetADDRCOUNTRY(val OptString)

SetADDRCOUNTRY sets the value of ADDRCOUNTRY.

func (*SearchAttributes) SetADDRFULL

func (s *SearchAttributes) SetADDRFULL(val OptString)

SetADDRFULL sets the value of ADDRFULL.

func (*SearchAttributes) SetADDRLINE1

func (s *SearchAttributes) SetADDRLINE1(val OptString)

SetADDRLINE1 sets the value of ADDRLINE1.

func (*SearchAttributes) SetADDRPOSTALCODE

func (s *SearchAttributes) SetADDRPOSTALCODE(val OptString)

SetADDRPOSTALCODE sets the value of ADDRPOSTALCODE.

func (*SearchAttributes) SetADDRSTATE

func (s *SearchAttributes) SetADDRSTATE(val OptString)

SetADDRSTATE sets the value of ADDRSTATE.

func (*SearchAttributes) SetDATEOFBIRTH

func (s *SearchAttributes) SetDATEOFBIRTH(val OptString)

SetDATEOFBIRTH sets the value of DATEOFBIRTH.

func (*SearchAttributes) SetDRIVERSLICENSENUMBER

func (s *SearchAttributes) SetDRIVERSLICENSENUMBER(val OptString)

SetDRIVERSLICENSENUMBER sets the value of DRIVERSLICENSENUMBER.

func (*SearchAttributes) SetEMAILADDRESS

func (s *SearchAttributes) SetEMAILADDRESS(val OptString)

SetEMAILADDRESS sets the value of EMAILADDRESS.

func (*SearchAttributes) SetNAMEFIRST

func (s *SearchAttributes) SetNAMEFIRST(val OptString)

SetNAMEFIRST sets the value of NAMEFIRST.

func (*SearchAttributes) SetNAMEFULL

func (s *SearchAttributes) SetNAMEFULL(val OptString)

SetNAMEFULL sets the value of NAMEFULL.

func (*SearchAttributes) SetNAMELAST

func (s *SearchAttributes) SetNAMELAST(val OptString)

SetNAMELAST sets the value of NAMELAST.

func (*SearchAttributes) SetNAMEMIDDLE

func (s *SearchAttributes) SetNAMEMIDDLE(val OptString)

SetNAMEMIDDLE sets the value of NAMEMIDDLE.

func (*SearchAttributes) SetNAMEORG

func (s *SearchAttributes) SetNAMEORG(val OptString)

SetNAMEORG sets the value of NAMEORG.

func (*SearchAttributes) SetNAMESUFFIX

func (s *SearchAttributes) SetNAMESUFFIX(val OptString)

SetNAMESUFFIX sets the value of NAMESUFFIX.

func (*SearchAttributes) SetNATIONALIDNUMBER

func (s *SearchAttributes) SetNATIONALIDNUMBER(val OptString)

SetNATIONALIDNUMBER sets the value of NATIONALIDNUMBER.

func (*SearchAttributes) SetPASSPORTCOUNTRY

func (s *SearchAttributes) SetPASSPORTCOUNTRY(val OptString)

SetPASSPORTCOUNTRY sets the value of PASSPORTCOUNTRY.

func (*SearchAttributes) SetPASSPORTNUMBER

func (s *SearchAttributes) SetPASSPORTNUMBER(val OptString)

SetPASSPORTNUMBER sets the value of PASSPORTNUMBER.

func (*SearchAttributes) SetPHONENUMBER

func (s *SearchAttributes) SetPHONENUMBER(val OptString)

SetPHONENUMBER sets the value of PHONENUMBER.

func (*SearchAttributes) SetSSNNUMBER

func (s *SearchAttributes) SetSSNNUMBER(val OptString)

SetSSNNUMBER sets the value of SSNNUMBER.

func (*SearchAttributes) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

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 UnimplementedHandler

type UnimplementedHandler struct{}

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

func (UnimplementedHandler) EntityDetailsEntityDetailsGet

EntityDetailsEntityDetailsGet implements entity_details_entity_details_get operation.

Retrieve entity data based on the ID of a resolved identity.

GET /entity_details

func (UnimplementedHandler) EntityHowEntityHowGet

EntityHowEntityHowGet implements entity_how_entity_how_get operation.

Determines and details steps-by-step how records resolved to an ENTITY_ID.

GET /entity_how

func (UnimplementedHandler) EntityReportEntityReportGet

EntityReportEntityReportGet implements entity_report_entity_report_get operation.

Return 10 entities with either matches, possible matches, or relationships.

GET /entity_report

func (UnimplementedHandler) EntitySearchEntitySearchPost

func (UnimplementedHandler) EntitySearchEntitySearchPost(ctx context.Context, req *SearchAttributes) (r EntitySearchEntitySearchPostRes, _ error)

EntitySearchEntitySearchPost implements entity_search_entity_search_post operation.

Retrieves entity data based on a user-specified set of entity attributes.

POST /entity_search

type ValidationError

type ValidationError struct {
	Loc  []ValidationErrorLocItem `json:"loc"`
	Msg  string                   `json:"msg"`
	Type string                   `json:"type"`
}

Ref: #/components/schemas/ValidationError

func (*ValidationError) Decode

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

Decode decodes ValidationError from json.

func (*ValidationError) Encode

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

Encode implements json.Marshaler.

func (*ValidationError) GetLoc

GetLoc returns the value of Loc.

func (*ValidationError) GetMsg

func (s *ValidationError) GetMsg() string

GetMsg returns the value of Msg.

func (*ValidationError) GetType

func (s *ValidationError) GetType() string

GetType returns the value of Type.

func (*ValidationError) MarshalJSON

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

MarshalJSON implements stdjson.Marshaler.

func (*ValidationError) SetLoc

func (s *ValidationError) SetLoc(val []ValidationErrorLocItem)

SetLoc sets the value of Loc.

func (*ValidationError) SetMsg

func (s *ValidationError) SetMsg(val string)

SetMsg sets the value of Msg.

func (*ValidationError) SetType

func (s *ValidationError) SetType(val string)

SetType sets the value of Type.

func (*ValidationError) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

func (*ValidationError) Validate

func (s *ValidationError) Validate() error

type ValidationErrorLocItem

type ValidationErrorLocItem struct {
	Type   ValidationErrorLocItemType // switch on this field
	String string
	Int    int
}

ValidationErrorLocItem represents sum type.

func NewIntValidationErrorLocItem

func NewIntValidationErrorLocItem(v int) ValidationErrorLocItem

NewIntValidationErrorLocItem returns new ValidationErrorLocItem from int.

func NewStringValidationErrorLocItem

func NewStringValidationErrorLocItem(v string) ValidationErrorLocItem

NewStringValidationErrorLocItem returns new ValidationErrorLocItem from string.

func (*ValidationErrorLocItem) Decode

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

Decode decodes ValidationErrorLocItem from json.

func (ValidationErrorLocItem) Encode

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

Encode encodes ValidationErrorLocItem as json.

func (ValidationErrorLocItem) GetInt

func (s ValidationErrorLocItem) GetInt() (v int, ok bool)

GetInt returns int and true boolean if ValidationErrorLocItem is int.

func (ValidationErrorLocItem) GetString

func (s ValidationErrorLocItem) GetString() (v string, ok bool)

GetString returns string and true boolean if ValidationErrorLocItem is string.

func (ValidationErrorLocItem) IsInt

func (s ValidationErrorLocItem) IsInt() bool

IsInt reports whether ValidationErrorLocItem is int.

func (ValidationErrorLocItem) IsString

func (s ValidationErrorLocItem) IsString() bool

IsString reports whether ValidationErrorLocItem is string.

func (ValidationErrorLocItem) MarshalJSON

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

MarshalJSON implements stdjson.Marshaler.

func (*ValidationErrorLocItem) SetInt

func (s *ValidationErrorLocItem) SetInt(v int)

SetInt sets ValidationErrorLocItem to int.

func (*ValidationErrorLocItem) SetString

func (s *ValidationErrorLocItem) SetString(v string)

SetString sets ValidationErrorLocItem to string.

func (*ValidationErrorLocItem) UnmarshalJSON

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

UnmarshalJSON implements stdjson.Unmarshaler.

type ValidationErrorLocItemType

type ValidationErrorLocItemType string

ValidationErrorLocItemType is oneOf type of ValidationErrorLocItem.

const (
	StringValidationErrorLocItem ValidationErrorLocItemType = "string"
	IntValidationErrorLocItem    ValidationErrorLocItemType = "int"
)

Possible values for ValidationErrorLocItemType.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL