schema
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
Stable versionWhen a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Overview¶
Package schema provides a validation framework for the API resources.
This package is part of the rest-layer project. Seehttp://rest-layer.io forfull REST Layer documentation.
Index¶
- Variables
- func VerifyPassword(hash interface{}, password []byte) bool
- type AllOf
- type AnyOf
- func (v AnyOf) Compile(rc ReferenceChecker) error
- func (v AnyOf) GetField(name string) *Field
- func (v AnyOf) LessFunc() LessFunc
- func (v AnyOf) Serialize(value interface{}) (interface{}, error)
- func (v AnyOf) Validate(value interface{}) (interface{}, error)
- func (v AnyOf) ValidateQuery(value interface{}) (interface{}, error)
- type Array
- type Bool
- type Boundaries
- type Compiler
- type Connection
- type Dict
- type ErrorMap
- type ErrorSlice
- type Field
- type FieldComparator
- type FieldGetter
- type FieldHandler
- type FieldQueryValidator
- type FieldSerializer
- type FieldValidator
- type FieldValidatorFunc
- type Fields
- type Float
- type IP
- type Integer
- type LessFunc
- type Null
- type Object
- type Param
- type Params
- type Password
- type Predicate
- type Reference
- type ReferenceChecker
- type ReferenceCheckerFunc
- type Schema
- func (s Schema) Compile(rc ReferenceChecker) error
- func (s Schema) GetField(name string) *Field
- func (s Schema) Prepare(ctx context.Context, payload map[string]interface{}, ...) (changes map[string]interface{}, base map[string]interface{})
- func (s Schema) Validate(changes map[string]interface{}, base map[string]interface{}) (doc map[string]interface{}, errs map[string][]interface{})
- type String
- type Time
- type URL
- type Validator
Examples¶
Constants¶
This section is empty.
Variables¶
var (// NewID is a field hook handler that generates a new globally unique id if// none exist, to be used in schema with OnInit.//// The generated ID is a Mongo like base64 object id (mgo/bson code has been// embedded into this function to prevent dep).NewID = func(ctxcontext.Context, value interface{}) interface{} {if value ==nil {value = newID()}return value}// IDField is a common schema field configuration that generate an globally// unique id for new item id.IDField =Field{Description: "The item's id",Required:true,ReadOnly:true,OnInit:NewID,Filterable:true,Sortable:true,Validator: &String{Regexp: "^[0-9a-v]{20}$",},})
var (// Now is a field hook handler that returns the current time, to be used in// schema with OnInit and OnUpdate.Now = func(ctxcontext.Context, value interface{}) interface{} {returntime.Now()}// CreatedField is a common schema field configuration for "created" fields.// It stores the creation date of the item.CreatedField =Field{Description: "The time at which the item has been inserted",Required:true,ReadOnly:true,OnInit:Now,Sortable:true,Validator: &Time{},}// UpdatedField is a common schema field configuration for "updated" fields.// It stores the current date each time the item is modified.UpdatedField =Field{Description: "The time at which the item has been last updated",Required:true,ReadOnly:true,OnInit:Now,OnUpdate:Now,Sortable:true,Validator: &Time{},})
var (// PasswordField is a common schema field for passwords. It encrypt the// password using bcrypt before storage and hide the value so the hash can't// be read back.PasswordField =Field{Description: "Write-only field storing a secret password.",Required:true,Hidden:true,Validator: &Password{},})
var Tombstone = internal{}Tombstone is used to mark a field for removal.
Functions¶
funcVerifyPassword¶
VerifyPassword compare a field of an item payload containing a hashedpassword with a clear text password and return true if they match.
Types¶
typeAllOf¶
type AllOf []FieldValidator
AllOf validates that all the sub field validators validates. Be aware thatthe order of the validators matter, as the result of one successfulvalidation is passed as input to the next.
func (AllOf)Compile¶
func (vAllOf) Compile(rcReferenceChecker) (errerror)
Compile implements the ReferenceCompiler interface.
func (AllOf)GetField¶added inv0.2.0
GetField implements the FieldGetter interface. Note that it will return thefirst matching field only.
func (AllOf)Validate¶
Validate ensures that all sub-validators validates. Note the result of onesuccessful validation is passed as input to the next. The result of the firsterror or last successful validation is returned.
func (AllOf)ValidateQuery¶added inv0.2.0
ValidateQuery implements schema.FieldQueryValidator interface. Note theresult of one successful validation is passed as input to the next. Theresult of the first error or last successful validation is returned.
typeAnyOf¶
type AnyOf []FieldValidator
AnyOf validates if any of the sub field validators validates. If any of thesub field validators implements the FieldSerializer interface, the *first*implementation which does not error will be used.
func (AnyOf)Compile¶
func (vAnyOf) Compile(rcReferenceChecker)error
Compile implements the Compiler interface.
func (AnyOf)GetField¶added inv0.2.0
GetField implements the FieldGetter interface. Note that it will return thefirst matching field only.
func (AnyOf)LessFunc¶added inv0.2.0
LessFunc implements the FieldComparator interface, and returns the firstnon-nil LessFunc or nil.
func (AnyOf)Serialize¶added inv0.2.0
Serialize attempts to serialize the value using the first availableFieldSerializer which does not return an error. If no appropriate serializeris found, the input value is returned.
func (AnyOf)ValidateQuery¶added inv0.2.0
ValidateQuery implements schema.FieldQueryValidator interface.
typeArray¶
type Array struct {// Values describes the properties for each array item.ValuesField// MinLen defines the minimum array length (default 0).MinLenint// MaxLen defines the maximum array length (default no limit).MaxLenint}Array validates array values.
func (*Array)Compile¶
func (v *Array) Compile(rcReferenceChecker) (errerror)
Compile implements the ReferenceCompiler interface.
func (Array)GetField¶added inv0.2.0
GetField implements the FieldGetter interface. It will returna Field if name corespond to a legal array index according toparameters set on v.
func (Array)ValidateQuery¶added inv0.2.0
ValidateQuery implements FieldQueryValidator.
typeBoundaries¶
Boundaries defines min/max for an integer.
typeCompiler¶
type Compiler interface {Compile(rcReferenceChecker)error}Compiler is similar to the Compiler interface, but intended for types that implements, or may hold, areference. All nested types must implement this interface.
typeConnection¶added inv0.2.0
Connection is a dummy validator to define a weak connection to anotherschema. The query.Projection will treat this validator as an externalresource, and generate a sub-request to fetch the sub-payload.
func (*Connection)Validate¶added inv0.2.0
func (v *Connection) Validate(value interface{}) (interface{},error)
Validate implements the FieldValidator interface.
typeDict¶
type Dict struct {// KeysValidator is the validator to apply on dict keys.KeysValidatorFieldValidator// Values describes the properties for each dict value.ValuesField// MinLen defines the minimum number of fields (default 0).MinLenint// MaxLen defines the maximum number of fields (default no limit).MaxLenint}Dict validates objects with variadic keys.
Example¶
package mainimport ("github.com/rs/rest-layer/schema")func main() {_ = schema.Schema{Fields: schema.Fields{"dict": schema.Field{Validator: &schema.Dict{// Limit dict keys to foo and bar keys onlyKeysValidator: &schema.String{Allowed: []string{"foo", "bar"},},// Allow either string or integer as dict valueValues: schema.Field{Validator: &schema.AnyOf{0: &schema.String{},1: &schema.Integer{},},},},},},}}func (*Dict)Compile¶
func (v *Dict) Compile(rcReferenceChecker) (errerror)
Compile implements the ReferenceCompiler interface.
typeErrorSlice¶added inv0.2.0
type ErrorSlice []error
ErrorSlice contains a concatenation of several errors.
func (ErrorSlice)Append¶added inv0.2.0
func (errErrorSlice) Append(othererror)ErrorSlice
Append adds an error to err and returns a new slice if others is not nil. Ifother is another ErrorSlice it is extended so that all elements are appended.
func (ErrorSlice)Error¶added inv0.2.0
func (errErrorSlice) Error()string
typeField¶
type Field struct {// Description stores a short description of the field useful for automatic// documentation generation.Descriptionstring// Required throws an error when the field is not provided at creation.Requiredbool// ReadOnly throws an error when a field is changed by the client.// Default and OnInit/OnUpdate hooks can be used to set/change read-only// fields.ReadOnlybool// Hidden allows writes but hides the field's content from the client. When// this field is enabled, PUTing the document without the field would not// remove the field but use the previous document's value if any.Hiddenbool// Default defines the value be stored on the field when when item is// created and this field is not provided by the client.Default interface{}// OnInit can be set to a function to generate the value of this field// when item is created. The function takes the current value if any// and returns the value to be stored.OnInit func(ctxcontext.Context, value interface{}) interface{}// OnUpdate can be set to a function to generate the value of this field// when item is updated. The function takes the current value if any// and returns the value to be stored.OnUpdate func(ctxcontext.Context, value interface{}) interface{}// Params defines a param handler for the field. The handler may change the field's// value depending on the passed parameters.ParamsParams// Handler is the piece of logic modifying the field value based on passed parameters.// This handler is only called if at least on parameter is provided.HandlerFieldHandler// Validator is used to validate the field's format. Please note you *must* pass in pointers to// FieldValidator instances otherwise `schema` will not be able to discover other interfaces,// such as `Compiler`, and *will* prevent schema from initializing specific FieldValidators// correctly causing unexpected runtime errors.// @seehttp://research.swtch.com/interfaces for more details.ValidatorFieldValidator// Dependency rejects the field if the schema predicate doesn't match the document.// Use query.MustParsePredicate(`{field: "value"}`) to populate this field.DependencyPredicate// Filterable defines that the field can be used with the `filter` parameter.// When this property is set to `true`, you may want to ensure the backend// database has this field indexed.Filterablebool// Sortable defines that the field can be used with the `sort` parameter.// When this property is set to `true`, you may want to ensure the backend// database has this field indexed.Sortablebool// Schema can be set to a sub-schema to allow multi-level schema.Schema *Schema}Field specifies the info for a single field of a spec
func (Field)Compile¶
func (fField) Compile(rcReferenceChecker)error
Compile implements the ReferenceCompiler interface and recursively compile sub schemasand validators when they implement Compiler interface.
typeFieldComparator¶added inv0.2.0
type FieldComparator interface {// LessFunc returns a valid LessFunc or nil. nil is returned when comparison// is not allowed.LessFunc()LessFunc}FieldComparator must be implemented by a FieldValidator that is to allowcomparison queries ($gt, $gte, $lt and $lte). The returned LessFunc will beused by the query package's Predicate.Match functions, which is used e.g. bythe internal mem storage backend.
typeFieldGetter¶added inv0.2.0
type FieldGetter interface {// GetField returns a Field for the given name if the name is allowed by// the schema. The field is expected to validate query values.//// You may reference a sub-field using dotted notation, e.g. field.subfield.GetField(namestring) *Field}FieldGetter defines an interface for fetching sub-fields from a Schema orFieldValidator implementation that allows (JSON) object values.
typeFieldHandler¶
type FieldHandler func(ctxcontext.Context, value interface{}, params map[string]interface{}) (interface{},error)
FieldHandler is the piece of logic modifying the field value based on passedparameters
typeFieldQueryValidator¶added inv0.2.0
type FieldQueryValidator interface {ValidateQuery(value interface{}) (interface{},error)}FieldQueryValidator defines an interface for lightweight validation on fieldtypes, without applying constrains on the actual values.
typeFieldSerializer¶
type FieldSerializer interface {// Serialize is called when the data is coming from it internal storable// form and needs to be prepared for representation (i.e.: just before JSON// marshaling).Serialize(value interface{}) (interface{},error)}FieldSerializer is used to convert the value between it's representation formand it internal storable form. A FieldValidator which implement thisinterface will have its Serialize method called before marshaling.
typeFieldValidator¶
type FieldValidator interface {Validate(value interface{}) (interface{},error)}FieldValidator is an interface for all individual validators. It takes avalue to validate as argument and returned the normalized value or an errorif validation failed.
typeFieldValidatorFunc¶added inv0.2.0
type FieldValidatorFunc func(value interface{}) (interface{},error)FieldValidatorFunc is an adapter to allow the use of ordinary functions asfield validators. If f is a function with the appropriate signature,FieldValidatorFunc(f) is a FieldValidator that calls f.
func (FieldValidatorFunc)Validate¶added inv0.2.0
func (fFieldValidatorFunc) Validate(value interface{}) (interface{},error)
Validate calls f(value).
typeFloat¶
type Float struct {Allowed []float64Boundaries *Boundaries}Float validates float based values.
func (Float)ValidateQuery¶added inv0.2.0
ValidateQuery implements schema.FieldQueryValidator interface
typeIP¶
type IP struct {// StoreBinary activates storage of the IP as binary to save space.// The storage requirement is 4 bytes for IPv4 and 16 bytes for IPv6.StoreBinarybool}IP validates IP values
typeInteger¶
type Integer struct {Allowed []intBoundaries *Boundaries}Integer validates integer based values.
func (Integer)ValidateQuery¶added inv0.2.0
ValidateQuery implements schema.FieldQueryValidator interface
typeLessFunc¶added inv0.2.0
type LessFunc func(value, other interface{})boolLessFunc is a function that returns true only when value is less than other,and false in all other circumstances, including error conditions.
typeObject¶
type Object struct {Schema *Schema}Object validates objects which are defined by Schemas.
func (*Object)Compile¶
func (v *Object) Compile(rcReferenceChecker)error
Compile implements the ReferenceCompiler interface.
typeParam¶
type Param struct {// Description of the parameterDescriptionstring// Validator to use for this parameterValidatorFieldValidator}Param define an individual field parameter with its validator
typePassword¶
type Password struct {// MinLen defines the minimum password length (default 0).MinLenint// MaxLen defines the maximum password length (default no limit).MaxLenint// Cost sets a custom bcrypt hashing cost.Costint}Password crypts a field password using bcrypt algorithm.
typeReference¶
Reference validates the ID of a linked resource.
func (*Reference)Compile¶added inv0.2.0
func (r *Reference) Compile(rcReferenceChecker)error
Compile validates v.Path against rc and stores the a FieldValidator for later use by v.Validate.
typeReferenceChecker¶added inv0.2.0
type ReferenceChecker interface {// ReferenceChecker should return a FieldValidator that can be used for validate that a referenced ID exists and// is of the right format. If there is no resource matching path, nil should e returned.ReferenceChecker(pathstring) (FieldValidator,Validator)}ReferenceChecker is used to retrieve a FieldValidator that can be used for validating referenced IDs.
typeReferenceCheckerFunc¶added inv0.2.0
type ReferenceCheckerFunc func(pathstring)FieldValidator
ReferenceCheckerFunc is an adapter that allows ordinary functions to be used as reference checkers.
func (ReferenceCheckerFunc)ReferenceChecker¶added inv0.2.0
func (fReferenceCheckerFunc) ReferenceChecker(pathstring)FieldValidator
ReferenceChecker calls f(path).
typeSchema¶
type Schema struct {// Description of the object described by this schema.Descriptionstring// Fields defines the schema's allowed fields.FieldsFields// MinLen defines the minimum number of fields (default 0).MinLenint// MaxLen defines the maximum number of fields (default no limit).MaxLenint}Schema defines fields for a document.
func (Schema)Compile¶
func (sSchema) Compile(rcReferenceChecker)error
Compile implements the ReferenceCompiler interface and call the same functionon each field. Note: if you use schema as a standalone library, it is the*caller's* responsibility to invoke the Compile method before using Prepareor Validate on a Schema instance, otherwise FieldValidator instances may notbe initialized correctly.
func (Schema)Prepare¶
func (sSchema) Prepare(ctxcontext.Context, payload map[string]interface{}, original *map[string]interface{}, replacebool) (changes map[string]interface{}, base map[string]interface{})
Prepare takes a payload with an optional original payout when updating anexisting item and return two maps, one containing changes operated by theuser and another defining either existing data (from the current item) ordata generated by the system thru "default" value or hooks.
If the original map is nil, prepare will act as if the payload is a newdocument. The OnInit hook is executed for each field if any, and defaultvalues are assigned to missing fields.
When the original map is defined, the payload is considered as an update onthe original document, default values are not assigned, and only fields whichare different than in the original are left in the change map. The OnUpdatehook is executed on each field.
If the replace argument is set to true with the original document set, thebehavior is slightly different as any field not present in the payload butpresent in the original are set to nil in the change map (instead of justbeing absent). This instruct the validator that the field has been edited, soReadOnly flag can throw an error and the field will be removed from theoutput document. The OnInit is also called instead of the OnUpdate.
func (Schema)Validate¶
func (sSchema) Validate(changes map[string]interface{}, base map[string]interface{}) (doc map[string]interface{}, errs map[string][]interface{})
Validate validates changes applied on a base document in regard to the schemaand generate an result document with the changes applied to the base document.All errors in the process are reported in the returned errs value.
typeString¶
type String struct {RegexpstringAllowed []stringMaxLenintMinLenint// contains filtered or unexported fields}String validates string based values
func (*String)Compile¶
func (v *String) Compile(rcReferenceChecker) (errerror)
Compile compiles and validate regexp if any.
func (String)ValidateQuery¶added inv0.2.0
ValidateQuery implements schema.FieldQueryValidator interface
typeTime¶
type Time struct {TimeLayouts []string// TimeLayouts is set of time layouts we want to validate.// contains filtered or unexported fields}Time validates time based values
func (Time)ValidateQuery¶added inv0.2.0
ValidateQuery implements schema.FieldQueryValidator interface
typeValidator¶
type Validator interface {GetField(namestring) *FieldPrepare(ctxcontext.Context, payload map[string]interface{}, original *map[string]interface{}, replacebool) (changes map[string]interface{}, base map[string]interface{})Validate(changes map[string]interface{}, base map[string]interface{}) (doc map[string]interface{}, errs map[string][]interface{})}Validator is an interface used to validate schema against actual data.
Source Files¶
Directories¶
| Path | Synopsis |
|---|---|
Package encoding is the intended hierarchy location for encoding Schema to other formats. | Package encoding is the intended hierarchy location for encoding Schema to other formats. |
jsonschema Package jsonschema provides JSON Schema Draft 4 encoding support for schema.Schema. | Package jsonschema provides JSON Schema Draft 4 encoding support for schema.Schema. |
Package query provides tools to query a schema defined by github.com/rs/schema. | Package query provides tools to query a schema defined by github.com/rs/schema. |