Documentation
¶
Overview ¶
Package api contains API models and definitions.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type ErrorDetail ¶
type ErrorDetail struct {
Message string `json:"message,omitempty"`
Location string `json:"location,omitempty"`
Value any `json:"value,omitempty"`
} // @name ErrorDetail
ErrorDetail represents a single error detail in the error response model.
type ErrorModel ¶
type ErrorModel struct {
// Type is a URI reference that identifies the problem type.
// example: "https://example.com/probs/out-of-credit"
Type string `json:"type,omitempty"`
// Title is a short, human-readable summary of the problem type.
// example: "Bad Request"
Title string `json:"title,omitempty"`
// Status is the HTTP status code generated by the origin server for this occurrence of the problem.
// example: 400
Status int `json:"status,omitempty"`
// Detail is a human-readable explanation specific to this occurrence of the problem.
// example: "Your request parameters didn't validate."
Detail string `json:"detail,omitempty"`
// Instance is a URI reference that identifies the specific occurrence of the problem.
Instance string `json:"instance,omitempty"`
// Errors provides additional error details.
Errors []*ErrorDetail `json:"errors,omitempty"`
} // @name ErrorModel
ErrorModel represents a standardized error response model. RFC 9457 Problem Details for HTTP APIs.
Source Files
Directories
¶
| Path | Synopsis |
|---|---|
|
Package v1 provides the API server for the application.
|
Package v1 provides the API server for the application. |
|
agent
Package agent provides the agent API for the server
|
Package agent provides the agent API for the server |
|
agentgroup
Package agentgroup provides the agentgroup API for the server
|
Package agentgroup provides the agentgroup API for the server |
|
auth
Package auth provides the authentication api for the opampcommander application
|
Package auth provides the authentication api for the opampcommander application |
|
command
Package command provides the command api model for opampcommander.
|
Package command provides the command api model for opampcommander. |
|
connection
Package connection provides the connection model and its methods
|
Package connection provides the connection model and its methods |
|
ping
Package ping provides the ping controller for the HTTP API.
|
Package ping provides the ping controller for the HTTP API. |
|
server
Package server provides the API models for server management.
|
Package server provides the API models for server management. |
|
version
Package version provides api model for version information.
|
Package version provides api model for version information. |
Click to show internal directories.
Click to hide internal directories.