core-contracts

module
v0.1.160 Latest Latest
Warning

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

Go to latest
Published: Apr 8, 2021 License: Apache-2.0

README

go-mod-core-contracts

This module contains the contract models used to describe data as it is passed via Request/Response between various EdgeX Foundry services. It also contains service clients for each service within the edgex-go repository. The definition of the various models and clients can be found in their respective top-level directories.

The default encoding for the models is JSON, although in at least one case -- DeviceProfile -- YAML encoding is also supported since a device profile is defined as a YAML document.

Installation
  • Make sure you're using at least Go 1.11.1 (EdgeX currently uses Go 1.15.x) and have modules enabled, i.e. have an initialized go.mod file
  • If your code is in your GOPATH then make sure GO111MODULE=on is set
  • Run go get github.com/edgexfoundry/go-mod-core-contracts
    • This will add the go-mod-core-contracts to the go.mod file and download it into the module cache

Directories

Path Synopsis
Package clients provides REST-based integration with the core APIs of the EdgeX Foundry platform.
Package clients provides REST-based integration with the core APIs of the EdgeX Foundry platform.
agent
agent provides a client for integrating with the system management agent.
agent provides a client for integrating with the system management agent.
command
Package command provides a client for integration with the core-command service.
Package command provides a client for integration with the core-command service.
coredata
coredata provides clients used for integration with the core-data service.
coredata provides clients used for integration with the core-data service.
general
general provides a client for calling operational endpoints that are present on all service APIs.
general provides a client for calling operational endpoints that are present on all service APIs.
logger
Package logger provides a client for integration with the support-logging service.
Package logger provides a client for integration with the support-logging service.
metadata
metadata provides clients used for integration with the core-metadata service.
metadata provides clients used for integration with the core-metadata service.
notifications
notifications provides a client for integrating with the support-notifications service.
notifications provides a client for integrating with the support-notifications service.
scheduler
scheduler provides clients used for integration with the support-scheduler service.
scheduler provides clients used for integration with the support-scheduler service.
urlclient/errors
errors defines a set of errors that urlclient will use.
errors defines a set of errors that urlclient will use.
requests
responses
v2

Jump to

Keyboard shortcuts

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