server

package
v1.5.1-0...-afa9cc1 Latest Latest
Warning

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

 Go to latest Published: Sep 20, 2023 License: MIT Imports: 4 Imported by: 3

Documentation

Overview

Package server provides primitives to interact the openapi HTTP API.

Code generated by github.com/deepmap/oapi-codegen DO NOT EDIT.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func RegisterHandlers 

func RegisterHandlers(router EchoRouter, si ServerInterface)

RegisterHandlers adds each server route to the EchoRouter.

Types

type ChildTree 

type ChildTree struct {
	// Embedded struct due to allOf(#/components/schemas/record-abstract)
	RecordAbstract

	// Arguments of a smart contract method.
	Arguments *string `json:"arguments,omitempty"`

	// Reference to the object that called this request.
	CallerReference *string `json:"caller_reference,omitempty"`

	// Reference to an existing state that was called during the execution of this request.
	ExecutionStateReference *string `json:"execution_state_reference,omitempty"`

	// True if request didn't change the object state. False otherwise.
	IsImmutable *bool `json:"is_immutable,omitempty"`

	// True if request is original. False otherwise.
	IsOriginalRequest *bool `json:"is_original_request,omitempty"`

	// Name of the smart contract method that called this request.
	Method *string `json:"method,omitempty"`

	// An array of references to subsequent requests in the tree.
	NextRequests *[]string `json:"next_requests,omitempty"`

	// Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object.
	PrototypeReference *string `json:"prototype_reference,omitempty"`

	// Reference to the parent request—a request that caused this one.
	ReasonReference *string `json:"reason_reference,omitempty"`

	// Request reference.
	Reference *string `json:"reference,omitempty"`

	// Reference to the result that was created by the execution of this request.
	ResultReference *string `json:"result_reference,omitempty"`

	// Root of the request tree—an original request.
	Root *bool `json:"root,omitempty"`

	// Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop.
	StateIndex *string `json:"state_index,omitempty"`

	// Reference to the new state that was created by the execution of this request.
	StateReference *string `json:"state_reference,omitempty"`

	// Internal debugging information. May be an empty string.
	TraceId *string `json:"trace_id,omitempty"`
}

ChildTree defines model for childTree.

type CodeError 

type CodeError struct {

	// Error code received from the backend services.
	Code *string `json:"code,omitempty"`

	// Additional information about the error.
	Description *string `json:"description,omitempty"`

	// Short error description.
	Message *string `json:"message,omitempty"`
}

CodeError defines model for code-error.

type CodeValidationError 

type CodeValidationError struct {

	// Error code received from the backend services.
	Code *string `json:"code,omitempty"`

	// Additional information about the error.
	Description *string `json:"description,omitempty"`

	// Short error description.
	Message *string `json:"message,omitempty"`

	// Array containing incorrect parameters/properties.
	ValidationFailures *[]CodeValidationFailures `json:"validation_failures,omitempty"`
}

CodeValidationError defines model for code-validation-error.

type CodeValidationFailures 

type CodeValidationFailures struct {

	// Failure reason.
	FailureReason *string `json:"failure_reason,omitempty"`

	// Property name.
	Property *string `json:"property,omitempty"`
}

CodeValidationFailures defines model for code-validation-failures.

type EchoRouter 

type EchoRouter interface {
	CONNECT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	DELETE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	GET(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	HEAD(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	OPTIONS(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PATCH(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	POST(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	PUT(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
	TRACE(path string, h echo.HandlerFunc, m ...echo.MiddlewareFunc) *echo.Route
}

This is a simple interface which specifies echo.Route addition functions which are present on both echo.Echo and echo.Group, since we want to allow using either of them for path registration

type FromIndex 

type FromIndex string

FromIndex defines model for from_index.

type FromJetDropId 

type FromJetDropId string

FromJetDropId defines model for from_jet_drop_id.

type FromPulseNumberParam 

type FromPulseNumberParam int64

FromPulseNumberParam defines model for fromPulseNumberParam.

type JetDrop 

type JetDrop struct {

	// Record hash.
	Hash *string `json:"hash,omitempty"`

	// Combination of `jet_id` and `pulse_number` separated by a `:`.
	JetDropId *string `json:"jet_drop_id,omitempty"`

	// Jet ID.
	JetId *string `json:"jet_id,omitempty"`

	// Next `jet_drop_id`.
	NextJetDropId *[]NextPrevJetDrop `json:"next_jet_drop_id,omitempty"`

	// Previous `jet_drop_id`.
	PrevJetDropId *[]NextPrevJetDrop `json:"prev_jet_drop_id,omitempty"`

	// Pulse number.
	PulseNumber *int64 `json:"pulse_number,omitempty"`

	// Number of all records in the pulse.
	RecordAmount *int64 `json:"record_amount,omitempty"`

	// Unix timestamp.
	Timestamp *int64 `json:"timestamp,omitempty"`
}

JetDrop defines model for jet-drop.

type JetDropIdPath 

type JetDropIdPath string

JetDropIdPath defines model for jet_drop_id_path.

type JetDropRecordsParams 

type JetDropRecordsParams struct {

	// Number of entries to show per page.
	Limit *Limit `json:"limit,omitempty"`

	// Number of entries to skip from the starting point (`from_*`).
	Offset *OffsetParam `json:"offset,omitempty"`

	// Specific `index` to paginate from.
	FromIndex *FromIndex `json:"from_index,omitempty"`

	// Record type to filter the obtained records by.
	Type *RecordTypeParam `json:"type,omitempty"`
}

JetDropRecordsParams defines parameters for JetDropRecords.

type JetDropResponse 

type JetDropResponse JetDrop

JetDropResponse defines model for jetDropResponse.

type JetDrops 

type JetDrops struct {

	// Array with a number entries as specified by filtering and pagination parameters.
	Result *[]JetDrop `json:"result,omitempty"`

	// Actual number of existing entries. May be higher or lower than the specified `limit`.
	Total *int64 `json:"total,omitempty"`
}

JetDrops defines model for jet-drops.

type JetDropsByJetIDParams 

type JetDropsByJetIDParams struct {

	// Number of entries to show per page.
	Limit *Limit `json:"limit,omitempty"`

	// Sorts by the `pulse_number` attribute of the returned object.
	// Can take two values that specify the sorting direction: descending (`pulse_number_desc`) or ascending (`pulse_number_asc`).
	SortBy *SortByPulse `json:"sort_by,omitempty"`

	// Starting point for a range of pulses—greater than or equal to the specified `pulse_number`.
	PulseNumberGte *PulseNumberGte `json:"pulse_number_gte,omitempty"`

	// Starting point for a range of pulses—greater than the specified `pulse_number`.
	PulseNumberGt *PulseNumberGt `json:"pulse_number_gt,omitempty"`

	// Ending point for a range of pulses—less than or equal to the specified `pulse_number`.
	PulseNumberLte *PulseNumberLte `json:"pulse_number_lte,omitempty"`

	// Ending point for a range of pulses—less than the specified `pulse_number`.
	PulseNumberLt *PulseNumberLt `json:"pulse_number_lt,omitempty"`
}

JetDropsByJetIDParams defines parameters for JetDropsByJetID.

type JetDropsByPulseNumberParams 

type JetDropsByPulseNumberParams struct {

	// Number of entries to show per page.
	Limit *Limit `json:"limit,omitempty"`

	// Number of entries to skip from the starting point (`from_*`).
	Offset *OffsetParam `json:"offset,omitempty"`

	// Specific `jet_drop_id` to paginate from.
	FromJetDropId *FromJetDropId `json:"from_jet_drop_id,omitempty"`
}

JetDropsByPulseNumberParams defines parameters for JetDropsByPulseNumber.

type JetDropsResponse 

type JetDropsResponse JetDrops

JetDropsResponse defines model for jetDropsResponse.

type JetIdPath 

type JetIdPath string

JetIdPath defines model for jet_id_path.

type Limit 

type Limit int

Limit defines model for limit.

type N400Response 

type N400Response CodeValidationError

N400Response defines model for 400Response.

type N500Response 

type N500Response CodeError

N500Response defines model for 500Response.

type NextPrevJetDrop 

type NextPrevJetDrop struct {

	// Combination of `jet_id` and `pulse_number` separated by a `:`.
	JetDropId *string `json:"jet_drop_id,omitempty"`

	// Jet ID.
	JetId *string `json:"jet_id,omitempty"`

	// Pulse number.
	PulseNumber *int64 `json:"pulse_number,omitempty"`
}

NextPrevJetDrop defines model for next-prev-jet-drop.

type ObjectLifelineParams 

type ObjectLifelineParams struct {

	// Number of entries to show per page.
	Limit *Limit `json:"limit,omitempty"`

	// Number of entries to skip from the starting point (`from_*`).
	Offset *OffsetParam `json:"offset,omitempty"`

	// Specific `index` to paginate from.
	FromIndex *FromIndex `json:"from_index,omitempty"`

	// Sorts by the `index` attribute of the returned object.
	// Can take two values that specify the sorting direction: descending (`index_desc`) or ascending (`index_asc`).
	SortBy *SortByIndex `json:"sort_by,omitempty"`

	// Starting point for a range of pulses—greater than the specified `pulse_number`.
	PulseNumberGt *PulseNumberGt `json:"pulse_number_gt,omitempty"`

	// Ending point for a range of pulses—less than the specified `pulse_number`.
	PulseNumberLt *PulseNumberLt `json:"pulse_number_lt,omitempty"`

	// Starting point for a range—greater than or equal to the specified `timestamp` in the Unix format.
	TimestampGte *TimestampGte `json:"timestamp_gte,omitempty"`

	// Ending point for a range—less than or equal to the specified `timestamp` in the Unix format.
	TimestampLte *TimestampLte `json:"timestamp_lte,omitempty"`
}

ObjectLifelineParams defines parameters for ObjectLifeline.

type ObjectReferencePath 

type ObjectReferencePath string

ObjectReferencePath defines model for object_reference_path.

type OffsetParam 

type OffsetParam int

OffsetParam defines model for offsetParam.

type OriginalRequestByObjectParams 

type OriginalRequestByObjectParams struct {

	// Number of entries to show per page.
	Limit *Limit `json:"limit,omitempty"`

	// Number of entries to skip from the starting point (`from_*`).
	Offset *OffsetParam `json:"offset,omitempty"`

	// Specific `index` to paginate from.
	FromIndex *FromIndex `json:"from_index,omitempty"`

	// Sorts by the `index` attribute of the returned object.
	// Can take two values that specify the sorting direction: descending (`index_desc`) or ascending (`index_asc`).
	SortBy *SortByIndex `json:"sort_by,omitempty"`

	// Starting point for a range of pulses—greater than the specified `pulse_number`.
	PulseNumberGt *PulseNumberGt `json:"pulse_number_gt,omitempty"`

	// Ending point for a range of pulses—less than the specified `pulse_number`.
	PulseNumberLt *PulseNumberLt `json:"pulse_number_lt,omitempty"`

	// Starting point for a range—greater than or equal to the specified `timestamp` in the Unix format.
	TimestampGte *TimestampGte `json:"timestamp_gte,omitempty"`

	// Ending point for a range—less than or equal to the specified `timestamp` in the Unix format.
	TimestampLte *TimestampLte `json:"timestamp_lte,omitempty"`
}

OriginalRequestByObjectParams defines parameters for OriginalRequestByObject.

type OriginalRequestResponse 

type OriginalRequestResponse OriginalRequests

OriginalRequestResponse defines model for OriginalRequestResponse.

type OriginalRequests 

type OriginalRequests struct {

	// Array with a number entries as specified by filtering and pagination parameters.
	Result *[]Request `json:"result,omitempty"`

	// Actual number of existing entries. May be higher or lower than the specified `limit`.
	Total *int64 `json:"total,omitempty"`
}

OriginalRequests defines model for original-requests.

type Pulse 

type Pulse struct {

	// Pulse completion status.
	IsComplete *bool `json:"is_complete,omitempty"`

	// Number of all jet drops in the pulse.
	JetDropAmount *int64 `json:"jet_drop_amount,omitempty"`

	// Next pulse number.
	NextPulseNumber *int64 `json:"next_pulse_number,omitempty"`

	// Previous pulse number.
	PrevPulseNumber *int64 `json:"prev_pulse_number,omitempty"`

	// Pulse number.
	PulseNumber *int64 `json:"pulse_number,omitempty"`

	// Number of all records in the pulse.
	RecordAmount *int64 `json:"record_amount,omitempty"`

	// Unix timestamp.
	Timestamp *int64 `json:"timestamp,omitempty"`
}

Pulse defines model for pulse.

type PulseNumberGt 

type PulseNumberGt int

PulseNumberGt defines model for pulse_number_gt.

type PulseNumberGte 

type PulseNumberGte int

PulseNumberGte defines model for pulse_number_gte.

type PulseNumberLt 

type PulseNumberLt int

PulseNumberLt defines model for pulse_number_lt.

type PulseNumberLte 

type PulseNumberLte int

PulseNumberLte defines model for pulse_number_lte.

type PulseNumberPath 

type PulseNumberPath int64

PulseNumberPath defines model for pulse_number_path.

type PulseResponse 

type PulseResponse Pulse

PulseResponse defines model for pulseResponse.

type Pulses 

type Pulses struct {

	// Array with a number entries as specified by filtering and pagination parameters.
	Result *[]Pulse `json:"result,omitempty"`

	// Actual number of existing entries. May be higher or lower than the specified `limit`.
	Total *int64 `json:"total,omitempty"`
}

Pulses defines model for pulses.

type PulsesParams 

type PulsesParams struct {

	// Number of entries to show per page.
	Limit *Limit `json:"limit,omitempty"`

	// Number of entries to skip from the starting point (`from_*`).
	Offset *OffsetParam `json:"offset,omitempty"`

	// Specific `pulse_number` to paginate from.
	FromPulseNumber *FromPulseNumberParam `json:"from_pulse_number,omitempty"`

	// Starting point for a range—greater than or equal to the specified `timestamp` in the Unix format.
	TimestampGte *TimestampGte `json:"timestamp_gte,omitempty"`

	// Ending point for a range—less than or equal to the specified `timestamp` in the Unix format.
	TimestampLte *TimestampLte `json:"timestamp_lte,omitempty"`

	// Starting point for a range of pulses—greater than the specified `pulse_number`.
	PulseNumberGt *PulseNumberGt `json:"pulse_number_gt,omitempty"`

	// Starting point for a range of pulses—greater than or equal to the specified `pulse_number`.
	PulseNumberGte *PulseNumberGte `json:"pulse_number_gte,omitempty"`

	// Ending point for a range of pulses—less than the specified `pulse_number`.
	PulseNumberLt *PulseNumberLt `json:"pulse_number_lt,omitempty"`

	// Ending point for a range of pulses—less than or equal to the specified `pulse_number`.
	PulseNumberLte *PulseNumberLte `json:"pulse_number_lte,omitempty"`

	// Sorting direction—ascending or descending relative to the monotonically increasing `pulse_number`.
	SortBy *SortByPulseNumber `json:"sort_by,omitempty"`
}

PulsesParams defines parameters for Pulses.

type PulsesResponse 

type PulsesResponse Pulses

PulsesResponse defines model for pulsesResponse.

type Record 

type Record struct {
	// Embedded struct due to allOf(#/components/schemas/record-abstract)
	RecordAbstract

	// Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop.
	Index *string `json:"index,omitempty"`

	// Combination of `jet_id` and `pulse_number` separated by a `:`.
	JetDropId *string `json:"jet_drop_id,omitempty"`

	// Record payload.
	Payload *string `json:"payload,omitempty"`

	// Reference to a previous record.
	PrevRecordReference *string `json:"prev_record_reference,omitempty"`

	// Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object.
	PrototypeReference *string `json:"prototype_reference,omitempty"`

	// Record reference.
	Reference *string `json:"reference,omitempty"`

	// Record type.
	Type *string `json:"type,omitempty"`
}

Record defines model for record.

type RecordAbstract 

type RecordAbstract struct {

	// Record hash.
	Hash *string `json:"hash,omitempty"`

	// Combination of `jet_id` and `pulse_number` separated by a `:`.
	JetDropId *string `json:"jet_drop_id,omitempty"`

	// Jet ID.
	JetId *string `json:"jet_id,omitempty"`

	// Reference to the corresponding object.
	ObjectReference *string `json:"object_reference,omitempty"`

	// Record number in a `jet drop`.
	Order *int64 `json:"order,omitempty"`

	// Pulse number.
	PulseNumber *int64 `json:"pulse_number,omitempty"`

	// Unix timestamp.
	Timestamp *int64 `json:"timestamp,omitempty"`
}

RecordAbstract defines model for record-abstract.

type RecordTypeParam 

type RecordTypeParam string

RecordTypeParam defines model for recordTypeParam. 

const (
	RecordTypeParam_request RecordTypeParam = "request"
	RecordTypeParam_result  RecordTypeParam = "result"
	RecordTypeParam_state   RecordTypeParam = "state"
)

List of RecordTypeParam

type Records 

type Records struct {

	// Array with a number entries as specified by filtering and pagination parameters.
	Result *[]Record `json:"result,omitempty"`

	// Actual number of existing entries. May be higher or lower than the specified `limit`.
	Total *int64 `json:"total,omitempty"`
}

Records defines model for records.

type RecordsResponse 

type RecordsResponse Records

RecordsResponse defines model for recordsResponse.

type Request 

type Request struct {
	// Embedded struct due to allOf(#/components/schemas/record-abstract)
	RecordAbstract

	// Arguments of a smart contract method.
	Arguments *string `json:"arguments,omitempty"`

	// Reference to the object that called this request.
	CallerReference *string `json:"caller_reference,omitempty"`

	// Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop.
	Index *string `json:"index,omitempty"`

	// True if request didn't change the object state. False otherwise.
	IsImmutable *bool `json:"is_immutable,omitempty"`

	// True if request is original. False otherwise.
	IsOriginalRequest *bool `json:"is_original_request,omitempty"`

	// Name of the smart contract method that called this request.
	Method *string `json:"method,omitempty"`

	// Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object.
	PrototypeReference *string `json:"prototype_reference,omitempty"`

	// Reference to the parent request—a request that caused this one.
	ReasonReference *string `json:"reason_reference,omitempty"`

	// Request reference.
	Reference *string `json:"reference,omitempty"`

	// Internal debugging information. May be an empty string.
	TraceId *string `json:"trace_id,omitempty"`
}

Request defines model for request.

type RequestReferencePath 

type RequestReferencePath string

RequestReferencePath defines model for request_reference_path.

type RequestTree 

type RequestTree struct {

	// An array containing request details and references to the corresponding result and state.
	Result *[]ChildTree `json:"result,omitempty"`
}

RequestTree defines model for requestTree.

type RequestTreeResponse 

type RequestTreeResponse RequestTree

RequestTreeResponse defines model for requestTreeResponse.

type Result 

type Result struct {
	// Embedded struct due to allOf(#/components/schemas/record-abstract)
	RecordAbstract

	// Result payload.
	Payload *string `json:"payload,omitempty"`

	// Result reference.
	Reference *string `json:"reference,omitempty"`

	// Reference to the corresponding request.
	RequestReference *string `json:"request_reference,omitempty"`
}

Result defines model for result.

type ResultResponse 

type ResultResponse Result

ResultResponse defines model for resultResponse.

type SearchJetDrop 

type SearchJetDrop struct {

	// Meta data.
	Meta *struct {

		// Combination of `jet_id` and `pulse_number` separated by a `:`.
		JetDropId *string `json:"jet_drop_id,omitempty"`
	} `json:"meta,omitempty"`

	// Result type.
	Type *string `json:"type,omitempty"`
}

SearchJetDrop defines model for search-jet-drop.

type SearchLifeline 

type SearchLifeline struct {

	// Meta data.
	Meta *struct {

		// Object reference.
		ObjectReference *string `json:"object_reference,omitempty"`
	} `json:"meta,omitempty"`

	// Result type.
	Type *string `json:"type,omitempty"`
}

SearchLifeline defines model for search-lifeline.

type SearchOriginalRequest 

type SearchOriginalRequest struct {

	// Meta data.
	Meta *struct {

		// Original request reference.
		Reference *string `json:"reference,omitempty"`
	} `json:"meta,omitempty"`

	// Result type.
	Type *string `json:"type,omitempty"`
}

SearchOriginalRequest defines model for search-original-request.

type SearchParams 

type SearchParams struct {

	// Searching value.
	Value string `json:"value"`
}

SearchParams defines parameters for Search.

type SearchPulse 

type SearchPulse struct {

	// Meta data.
	Meta *struct {

		// Pulse number.
		PulseNumber *int64 `json:"pulse_number,omitempty"`
	} `json:"meta,omitempty"`

	// Result type.
	Type *string `json:"type,omitempty"`
}

SearchPulse defines model for search-pulse.

type SearchRequest 

type SearchRequest struct {

	// Meta data.
	Meta *struct {

		// Request reference.
		Reference *string `json:"reference,omitempty"`
	} `json:"meta,omitempty"`

	// Result type.
	Type *string `json:"type,omitempty"`
}

SearchRequest defines model for search-request.

type SearchResponse 

type SearchResponse interface{}

SearchResponse defines model for searchResponse.

type SearchState 

type SearchState struct {

	// Meta data.
	Meta *struct {

		// Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop.
		Index *string `json:"index,omitempty"`

		// Reference to the corresponding object.
		ObjectReference *string `json:"object_reference,omitempty"`
	} `json:"meta,omitempty"`

	// Result type.
	Type *string `json:"type,omitempty"`
}

SearchState defines model for search-state.

type ServerInterface 

type ServerInterface interface {
	// Jet drop by ID
	// (GET /api/v1/jet-drops/{jet_drop_id})
	JetDropByID(ctx echo.Context, jetDropId JetDropIdPath) error
	// Records
	// (GET /api/v1/jet-drops/{jet_drop_id}/records)
	JetDropRecords(ctx echo.Context, jetDropId JetDropIdPath, params JetDropRecordsParams) error
	// Jet drops by jet ID
	// (GET /api/v1/jets/{jet_id}/jet-drops)
	JetDropsByJetID(ctx echo.Context, jetId JetIdPath, params JetDropsByJetIDParams) error
	// Original request by object
	// (GET /api/v1/lifeline/{object_reference}/original-requests)
	OriginalRequestByObject(ctx echo.Context, objectReference ObjectReferencePath, params OriginalRequestByObjectParams) error
	// Object lifeline
	// (GET /api/v1/lifeline/{object_reference}/states)
	ObjectLifeline(ctx echo.Context, objectReference ObjectReferencePath, params ObjectLifelineParams) error
	// Pulses
	// (GET /api/v1/pulses)
	Pulses(ctx echo.Context, params PulsesParams) error
	// Pulse
	// (GET /api/v1/pulses/{pulse_number})
	Pulse(ctx echo.Context, pulseNumber PulseNumberPath) error
	// Jet drops by pulse number
	// (GET /api/v1/pulses/{pulse_number}/jet-drops)
	JetDropsByPulseNumber(ctx echo.Context, pulseNumber PulseNumberPath, params JetDropsByPulseNumberParams) error
	// Request
	// (GET /api/v1/requests/{request_reference})
	Request(ctx echo.Context, requestReference RequestReferencePath) error
	// Request tree
	// (GET /api/v1/requests/{request_reference}/call-tree)
	RequestTree(ctx echo.Context, requestReference RequestReferencePath) error
	// Original request
	// (GET /api/v1/requests/{request_reference}/original-request)
	Originalrequest(ctx echo.Context, requestReference RequestReferencePath) error
	// Result
	// (GET /api/v1/requests/{request_reference}/result)
	Result(ctx echo.Context, requestReference RequestReferencePath) error
	// Search
	// (GET /api/v1/search)
	Search(ctx echo.Context, params SearchParams) error
}

ServerInterface represents all server handlers.

type ServerInterfaceWrapper 

type ServerInterfaceWrapper struct {
	Handler ServerInterface
}

ServerInterfaceWrapper converts echo contexts to parameters.

func (*ServerInterfaceWrapper) JetDropByID 

func (w *ServerInterfaceWrapper) JetDropByID(ctx echo.Context) error

JetDropByID converts echo context to params.

func (*ServerInterfaceWrapper) JetDropRecords 

func (w *ServerInterfaceWrapper) JetDropRecords(ctx echo.Context) error

JetDropRecords converts echo context to params.

func (*ServerInterfaceWrapper) JetDropsByJetID 

func (w *ServerInterfaceWrapper) JetDropsByJetID(ctx echo.Context) error

JetDropsByJetID converts echo context to params.

func (*ServerInterfaceWrapper) JetDropsByPulseNumber 

func (w *ServerInterfaceWrapper) JetDropsByPulseNumber(ctx echo.Context) error

JetDropsByPulseNumber converts echo context to params.

func (*ServerInterfaceWrapper) ObjectLifeline 

func (w *ServerInterfaceWrapper) ObjectLifeline(ctx echo.Context) error

ObjectLifeline converts echo context to params.

func (*ServerInterfaceWrapper) OriginalRequestByObject 

func (w *ServerInterfaceWrapper) OriginalRequestByObject(ctx echo.Context) error

OriginalRequestByObject converts echo context to params.

func (*ServerInterfaceWrapper) Originalrequest 

func (w *ServerInterfaceWrapper) Originalrequest(ctx echo.Context) error

Originalrequest converts echo context to params.

func (*ServerInterfaceWrapper) Pulse 

func (w *ServerInterfaceWrapper) Pulse(ctx echo.Context) error

Pulse converts echo context to params.

func (*ServerInterfaceWrapper) Pulses 

func (w *ServerInterfaceWrapper) Pulses(ctx echo.Context) error

Pulses converts echo context to params.

func (*ServerInterfaceWrapper) Request 

func (w *ServerInterfaceWrapper) Request(ctx echo.Context) error

Request converts echo context to params.

func (*ServerInterfaceWrapper) RequestTree 

func (w *ServerInterfaceWrapper) RequestTree(ctx echo.Context) error

RequestTree converts echo context to params.

func (*ServerInterfaceWrapper) Result 

func (w *ServerInterfaceWrapper) Result(ctx echo.Context) error

Result converts echo context to params.

func (*ServerInterfaceWrapper) Search 

func (w *ServerInterfaceWrapper) Search(ctx echo.Context) error

Search converts echo context to params.

type SortByIndex 

type SortByIndex string

SortByIndex defines model for sort_by_index. 

const (
	SortByIndex_index_asc  SortByIndex = "index_asc"
	SortByIndex_index_desc SortByIndex = "index_desc"
)

List of SortByIndex

type SortByPulse 

type SortByPulse string

SortByPulse defines model for sort_by_pulse. 

const (
	SortByPulse_pulse_number_asc_jet_id_desc SortByPulse = "pulse_number_asc,jet_id_desc"
	SortByPulse_pulse_number_desc_jet_id_asc SortByPulse = "pulse_number_desc,jet_id_asc"
)

List of SortByPulse

type SortByPulseNumber 

type SortByPulseNumber string

SortByPulseNumber defines model for sort_by_pulse_number. 

const (
	SortByPulseNumber_pulse_number_asc  SortByPulseNumber = "pulse_number_asc"
	SortByPulseNumber_pulse_number_desc SortByPulseNumber = "pulse_number_desc"
)

List of SortByPulseNumber

type State 

type State struct {

	// Record hash.
	Hash *string `json:"hash,omitempty"`

	// Combination of `pulse_number` and `order` separated by a `:`. Order is a record number in a jet drop.
	Index *string `json:"index,omitempty"`

	// Combination of `jet_id` and `pulse_number` separated by a `:`.
	JetDropId *string `json:"jet_drop_id,omitempty"`

	// Jet ID.
	JetId *string `json:"jet_id,omitempty"`

	// Object reference.
	ObjectReference *string `json:"object_reference,omitempty"`

	// Record number in a `jet drop`.
	Order *int64 `json:"order,omitempty"`

	// Reference to the parent object that caused creation of the given object. For example, a member object is a parent of its deposit account object.
	ParentReference *string `json:"parent_reference,omitempty"`

	// Record payload.
	Payload *string `json:"payload,omitempty"`

	// Reference to a previous record.
	PrevStateReference *string `json:"prev_state_reference,omitempty"`

	// Prototype reference. Borrowing the OOP terminology, a prototype is a class of an object.
	PrototypeReference *string `json:"prototype_reference,omitempty"`

	// Pulse number.
	PulseNumber *int64 `json:"pulse_number,omitempty"`

	// State reference.
	Reference *string `json:"reference,omitempty"`

	// Reference to the corresponding request.
	RequestReference *string `json:"request_reference,omitempty"`

	// Unix timestamp.
	Timestamp *int64 `json:"timestamp,omitempty"`

	// State type.
	Type *string `json:"type,omitempty"`
}

State defines model for state.

type States 

type States struct {

	// Array with a number entries as specified by filtering and pagination parameters.
	Result *[]State `json:"result,omitempty"`

	// Actual number of existing entries. May be higher or lower than the specified `limit`.
	Total *int64 `json:"total,omitempty"`
}

States defines model for states.

type StatesResponse 

type StatesResponse States

StatesResponse defines model for statesResponse.

type TimestampGte 

type TimestampGte int64

TimestampGte defines model for timestamp_gte.

type TimestampLte 

type TimestampLte int64

TimestampLte defines model for timestamp_lte.

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.