add documentation for types package
This commit is contained in:
parent
7acd4803d0
commit
9b3f2fddb1
|
@ -0,0 +1,9 @@
|
|||
/*
|
||||
Package types provides types to check incoming parameters for validity.
|
||||
|
||||
Each type implements the UnmarshalJSON interface, so that it can be fed into
|
||||
the Request parser.
|
||||
At that time, each error in the parameter is catched and will result in an
|
||||
error, so that clients are required to return the correct data.
|
||||
*/
|
||||
package types
|
|
@ -6,6 +6,7 @@ import (
|
|||
)
|
||||
|
||||
type (
|
||||
// Zone represents the name of a zone. A zone must end with a `.`.
|
||||
Zone string
|
||||
)
|
||||
|
||||
|
|
Loading…
Reference in New Issue