doc

package module
v1.3.1 Latest Latest
Warning

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

Go to latest
Published: Jan 26, 2021 License: Apache-2.0 Imports: 0 Imported by: 0

README

Go

Application Functions SDK

Welcome the App Functions SDK for EdgeX. This sdk is meant to provide all the plumbing necessary for developers to get started in processing/transforming/exporting data out of EdgeX.

For documentation please visit https://docs.edgexfoundry.org/1.2/microservices/application/ApplServices/. For a list of examples please visit https://docs.edgexfoundry.org/1.2/examples/AppServiceExamples/

Build Prerequisites

Please see the edgex-go README.

Versioning

Please refer to the EdgeX Foundry versioning policy for information on how EdgeX services are released and how EdgeX services are compatible with one another. Specifically, device services (and the associated SDK), application services (and the associated app functions SDK), and client tools (like the EdgeX CLI and UI) can have independent minor releases, but these services must be compatible with the latest major release of EdgeX.

Long Term Support

Please refer to the EdgeX Foundry LTS policy for information on support of EdgeX releases. The EdgeX community does not offer support on any non-LTS release outside of the latest release.

Documentation

Overview

App Functions SDK API.

Welcome the App Functions SDK for EdgeX. This sdk is meant to provide all the plumbing necessary for developers to get started in processing/transforming/exporting data out of EdgeX. For full documentation on this SDK please visit https://github.com/edgexfoundry/app-functions-sdk-go/blob/master/README.md

This Swagger Document focuses on the few restful APIs provided with the SDK, however the complete documentation for all available features can be found here https://github.com/edgexfoundry/app-functions-sdk-go/blob/master/README.md .

Schemes: http
Host: localhost
BasePath: /api/v1/
Version: 1.0.0
License: Apache-2.0 https://github.com/edgexfoundry/app-functions-sdk-go/blob/master/LICENSE

Contact: https://edgex.discourse.group/c/applications

Consumes:
- application/json

Produces:
- application/json

swagger:meta

Directories

Path Synopsis
store/contracts
contracts are implementation agnostic data storage models.
contracts are implementation agnostic data storage models.
store/db
db provides useful constants, identifiers, and simple types that apply to all implementations of the store
db provides useful constants, identifiers, and simple types that apply to all implementations of the store
store/db/interfaces
interfaces establishes the contract required for any implementation of the export store functionality in a database provider.
interfaces establishes the contract required for any implementation of the export store functionality in a database provider.
store/db/mongo
mongo provides the Mongo implementation of the StoreClient interface.
mongo provides the Mongo implementation of the StoreClient interface.
store/db/mongo/models
models describes the data types that will be used when storing export data in Mongo.
models describes the data types that will be used when storing export data in Mongo.
store/db/redis
redis provides the Redis implementation of the StoreClient interface.
redis provides the Redis implementation of the StoreClient interface.
store/db/redis/models
models describes the data types that will be used when storing export data in Redis.
models describes the data types that will be used when storing export data in Redis.
pkg

Jump to

Keyboard shortcuts

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