Godoc fixes (#898)

Add some godoc comments for the api/agent package and some of its
subpackages.
This commit is contained in:
Justin Ko
2018-03-28 10:16:41 -07:00
committed by Reed Allman
parent 14af8805de
commit 9cb883ca68
7 changed files with 68 additions and 8 deletions

12
api/agent/protocol/doc.go Normal file
View File

@@ -0,0 +1,12 @@
// Package protocol defines the protocol between the Fn Agent and the code
// running inside of a container. When an Fn Agent wants to perform a function
// call it needs to pass that call to a container over stdin. The call is
// encoded in one of the following protocols.
//
// * Default I/O Format
// * JSON I/O Format
// * HTTP I/O Format
//
// For more information on the function formats see
// https://github.com/fnproject/fn/blob/master/docs/developers/function-format.md.
package protocol