example

Documentation

Index

• Variables
• func ExampleValidateFieldSelection(methodName string, s *query.FieldSelection) error
• func ExampleValidateFiltering(methodName string, f *query.Filtering) error
• func ExampleValidateSorting(methodName string, s *query.Sorting) error

Variables

var ExampleMethodsRequireFieldSelectionValidation = map[string][]string{
	"/example.TestService/List": {
		"first_name",
		"weight",
		"on_vacation",
		"speciality",
		"comment",
		"last_name",
		"id",
		"array",
		"custom_type",
		"custom_type_string",
		"home_address.city",
		"home_address.country",
		"home_address",
		"work_address.city",
		"work_address.country",
		"work_address",
		"company",
		"nationality",
	},
	"/example.TestService/Read": {
		"first_name",
		"weight",
		"on_vacation",
		"speciality",
		"comment",
		"last_name",
		"id",
		"array",
		"custom_type",
		"custom_type_string",
		"home_address.city",
		"home_address.country",
		"home_address",
		"work_address.city",
		"work_address.country",
		"work_address",
		"company",
		"nationality",
	},
}

var ExampleMethodsRequireFilteringValidation = map[string]map[string]options.FilteringOption{
	"/example.TestService/List": map[string]options.FilteringOption{
		"first_name":           options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_GT, options.QueryValidate_GE, options.QueryValidate_LT, options.QueryValidate_LE, options.QueryValidate_IN, options.QueryValidate_IEQ}, ValueType: options.QueryValidate_STRING},
		"weight":               options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_LE}, ValueType: options.QueryValidate_NUMBER},
		"on_vacation":          options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_ALL}, ValueType: options.QueryValidate_DEFAULT},
		"speciality":           options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_EQ, options.QueryValidate_GT, options.QueryValidate_GE, options.QueryValidate_LT, options.QueryValidate_LE, options.QueryValidate_IN, options.QueryValidate_IEQ}, ValueType: options.QueryValidate_STRING},
		"comment":              options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_IN}, ValueType: options.QueryValidate_STRING},
		"last_name":            options.FilteringOption{ValueType: options.QueryValidate_STRING},
		"id":                   options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_ALL}, ValueType: options.QueryValidate_STRING},
		"array":                options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_ALL}, ValueType: options.QueryValidate_DEFAULT},
		"custom_type":          options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_ALL}, ValueType: options.QueryValidate_DEFAULT},
		"custom_type_string":   options.FilteringOption{ValueType: options.QueryValidate_STRING},
		"home_address.city":    options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_MATCH, options.QueryValidate_GT, options.QueryValidate_GE, options.QueryValidate_LT, options.QueryValidate_LE, options.QueryValidate_IN, options.QueryValidate_IEQ}, ValueType: options.QueryValidate_STRING},
		"home_address.country": options.FilteringOption{ValueType: options.QueryValidate_STRING},
		"work_address":         options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_ALL}, ValueType: options.QueryValidate_DEFAULT},
		"company":              options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_IEQ}, ValueType: options.QueryValidate_STRING},
		"nationality":          options.FilteringOption{Deny: []options.QueryValidate_FilterOperator{options.QueryValidate_IN}, ValueType: options.QueryValidate_STRING},
	},
}

var ExampleMethodsRequireSortingValidation = map[string][]string{
	"/example.TestService/List": []string{
		"first_name",
		"weight",
		"comment",
		"last_name",
		"id",
		"custom_type_string",
		"home_address.country",
		"company",
		"nationality",
	},
	"/example.TestService/Read": []string{
		"first_name",
		"weight",
		"comment",
		"last_name",
		"id",
		"custom_type_string",
		"home_address.country",
		"company",
		"nationality",
	},
}

Functions

func ExampleValidateFieldSelection

func ExampleValidateFieldSelection(methodName string, s *query.FieldSelection) error

func ExampleValidateFiltering

func ExampleValidateFiltering(methodName string, f *query.Filtering) error

func ExampleValidateSorting

func ExampleValidateSorting(methodName string, s *query.Sorting) error