note

Documentation

Overview

Package note provides models for generating simple messages.

Index

• type Message
  • func (Message) JSONSchemaExtend(s *jsonschema.Schema)
  • func (m *Message) Validate() error

Types

type Message

type Message struct {
	// Summary of the message content
	Title string `json:"title,omitempty" jsonschema:"title=Title"`
	// Details of what exactly this message wants to communicate.
	Content string `json:"content" jsonschema:"title=Content"`
	// Any additional semi-structured data that might be useful.
	Meta cbc.Meta `json:"meta,omitempty" jsonschema:"title=Meta Data"`
}

Message represents a simple message object with a title and some content meant.

func (Message) JSONSchemaExtend

func (Message) JSONSchemaExtend(s *jsonschema.Schema)

JSONSchemaExtend adds examples to the JSON Schema.

func (*Message) Validate

func (m *Message) Validate() error

Validate ensures the message contains everything it should.