The highest tagged major version is
Documentation
¶
Index ¶
Constants ¶
const API_VERSION = "v2"
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BaseRequest ¶
type BaseRequest struct {
RequestID string `json:"requestId" validate:"uuid"`
}
Request defines the base content for request DTOs (data transfer objects). This object and its properties correspond to the BaseRequest object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/BaseRequest
type BaseResponse ¶
type BaseResponse struct {
Versionable `json:",inline"`
RequestID string `json:"requestId"`
Message interface{} `json:"message,omitempty"`
StatusCode uint16 `json:"statusCode"`
}
BaseResponse defines the base content for response DTOs (data transfer objects). This object and its properties correspond to the BaseResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/BaseResponse
type ConfigResponse ¶
type ConfigResponse struct {
BaseResponse `json:",inline"`
Config interface{} `json:"config"`
}
ConfigResponse defines the configuration for the targeted service. This object and its properties correspond to the ConfigResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/ConfigResponse
type MetricsResponse ¶
type MetricsResponse struct {
BaseResponse `json:",inline"`
MemAlloc uint64 `json:"memAlloc"`
MemFrees uint64 `json:"memFrees"`
MemLiveObjects uint64 `json:"memLiveObjects"`
MemMallocs uint64 `json:"memMallocs"`
MemSys uint64 `json:"memSys"`
MemTotalAlloc uint64 `json:"memTotalAlloc"`
CpuBusyAvg uint8 `json:"cpuBusyAvg"`
}
MetricsResponse defines the providing memory and cpu utilization stats of the service. This object and its properties correspond to the MetricsResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/MetricsResponse
type PingResponse ¶
type PingResponse struct {
BaseResponse `json:",inline"`
Timestamp string `json:"timestamp"`
}
PingResponse defines the content of response content for POST Ping DTO This object and its properties correspond to the Ping object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/PingResponse
type VersionResponse ¶
type VersionResponse struct {
BaseResponse `json:",inline"`
Version string `json:"version"`
}
VersionResponse defines the latest version supported by the service. This object and its properties correspond to the VersionResponse object in the APIv2 specification: https://app.swaggerhub.com/apis-docs/EdgeXFoundry1/core-data/2.x#/VersionResponse
type VersionSdkResponse ¶
type VersionSdkResponse struct {
VersionResponse `json:",inline"`
SdkVersion string `json:"sdk_version"`
}
VersionSdkResponse defines the latest sdk version supported by the service. This object and its properties correspond to the VersionSdkResponse object in the APIv2 specification:
type Versionable ¶ added in v0.1.65
type Versionable struct {
ApiVersion string `json:"apiVersion,omitempty"`
}
Versionable shows the API version in DTOs
Source Files