api

package

v0.1.0 Latest Latest Go to latest Published: Oct 8, 2023 License: BSD-3-Clause Imports: 3 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/rotationalio/rtnl.link

Links

Open Source Insights

Documentation ¶

Index ¶

Variables
type PageQuery
type QuarterdeckClient
type Reply
- func ErrorResponse(err interface{}) Reply
type StatusReply

Constants ¶

This section is empty.

Variables ¶

View Source

var (
	ErrUnsuccessfulReply = Reply{Success: false}
	ErrNotFoundReply     = Reply{Success: false, Error: "resource not found"}
	ErrNotAllowedReply   = Reply{Success: false, Error: "method not allowed"}
)

Functions ¶

This section is empty.

Types ¶

type PageQuery ¶

type PageQuery struct {
	PageSize      int    `json:"page_size" url:"page_size,omitempty" form:"page_size"`
	NextPageToken string `json:"next_page_token" url:"next_page_token,omitempty" form:"next_page_token"`
}

PageQuery manages paginated list requests.

type QuarterdeckClient ¶

type QuarterdeckClient interface {
	// Unauthenticated endpoints
	Status(context.Context) (*StatusReply, error)
}

type Reply ¶

type Reply struct {
	Success    bool   `json:"success"`
	Error      string `json:"error,omitempty"`
	Unverified bool   `json:"unverified,omitempty"`
}

Reply contains standard fields that are used for generic API responses and errors.

func ErrorResponse ¶

func ErrorResponse(err interface{}) Reply

Construct a new response for an error or simply return unsuccessful.

type StatusReply ¶

type StatusReply struct {
	Status  string `json:"status"`
	Uptime  string `json:"uptime,omitempty"`
	Version string `json:"version,omitempty"`
}

Returned on status requests.

Source Files ¶

View all Source files

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