schemas

package

v1.0.6-1 Latest Latest Go to latest Published: Jan 13, 2020 License: Apache-2.0 Imports: 10 Imported by: 2

Details

Valid go.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 version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ARGOeu/argo-messaging

Documentation ¶

Index ¶

Constants
func Delete(schemaUUID string, str stores.Store) error
func ExistsWithName(projectUUID string, schemaName string, str stores.Store) (bool, error)
func ExtractSchema(schemaRef string) (string, string, error)
func FormatSchemaRef(projectName, schemaName string) string
func ValidateMessages(schema Schema, msgList messages.MsgList) error
type Schema
- func Create(projectUUID, schemaUUID, name, schemaType string, ...) (Schema, error)
- func Update(existingSchema Schema, newSchemaName, newSchemaType string, ...) (Schema, error)
type SchemaList
- func Find(projectUUID, schemaUUID, schemaName string, str stores.Store) (SchemaList, error)
- func (sl *SchemaList) Empty() bool

Constants ¶

View Source

const (
	JSON                   = "json"
	UnsupportedSchemaError = `Schema type can only be 'json'`
	GenericError           = "Could not load schema for topic"
)

Variables ¶

This section is empty.

Functions ¶

func Delete ¶

func Delete(schemaUUID string, str stores.Store) error

Delete wraps the store's method for removing a schema

func ExistsWithName ¶

func ExistsWithName(projectUUID string, schemaName string, str stores.Store) (bool, error)

ExistsWithName checks if a schema with the given name exists under the given project

func ExtractSchema ¶

func ExtractSchema(schemaRef string) (string, string, error)

ExtractSchema gets a full schema ref and extracts project and schema the format of the schema ref should follow the pattern projects/{project}/schemas/schema

func FormatSchemaRef ¶

func FormatSchemaRef(projectName, schemaName string) string

FormatSchemaRef formats the full resource reference for a schema format is projects/{project}/schemas/{schema}

func ValidateMessages ¶

func ValidateMessages(schema Schema, msgList messages.MsgList) error

ValidateMessages validates a list of messages against the provided schema

Types ¶

type Schema ¶

type Schema struct {
	ProjectUUID string                 `json:"-"`
	UUID        string                 `json:"uuid"`
	Name        string                 `json:"-"`
	FullName    string                 `json:"name"`
	Type        string                 `json:"type"`
	RawSchema   map[string]interface{} `json:"schema"`
}

Schema holds information regarding a schema that will be used to validate a topic's published messages

func Create ¶

func Create(projectUUID, schemaUUID, name, schemaType string, rawSchema map[string]interface{}, str stores.Store) (Schema, error)

Create checks the validity of the schema to be created and then saves it to the store

func Update ¶

func Update(existingSchema Schema, newSchemaName, newSchemaType string, newRawSchema map[string]interface{}, str stores.Store) (Schema, error)

Update updates the provided schema , validates its content and saves it to the store

type SchemaList ¶

type SchemaList struct {
	Schemas []Schema `json:"schemas"`
}

SchemaList is a wrapper for a slice of schemas

func Find ¶

func Find(projectUUID, schemaUUID, schemaName string, str stores.Store) (SchemaList, error)

Find retrieves a specific schema or all the schemas under a project

func (*SchemaList) Empty ¶

func (sl *SchemaList) Empty() bool

Empty returns weather or not there are any schemas inside the schema list

Source Files ¶

View all Source files

schema.go

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