model

Documentation

Index

• Variables
• func DumpToMap(input interface{}) map[string]any
• type ArrayItem
• type Property
  • func ArrayOf(p Property) Property
  • func Optional(p Property) Property
  • func (s Property) IsBoolean() bool
  • func (s Property) IsDateTime() bool
  • func (s Property) IsInteger() bool
  • func (s Property) IsNumber() bool
• type Schema

Variables

var APIKey apiKeyV2

var ActionV2 actionV2

var ActorV2 actorV2

var CustomFieldEntryV1 customFieldEntryV1

var CustomFieldOptionV1 customFieldOptionV1

var CustomFieldTypeInfoV1 customFieldTypeInfoV1

var CustomFieldV2 customFieldV2

var CustomFieldValueV1 customFieldValueV1

var DateTime dateTime

var EmbeddedCatalogEntryV1 embeddedCatalogEntryV1

var ExternalIssueReferenceV2 externalIssueReferenceV2

var ExternalResourceV1 externalResourceV1

var FollowUpPriorityV2 followUpPriorityV2

var FollowUpV2 followUpV2

var IncidentAttachmentV1 incidentAttachmentV1

var IncidentRoleAssignmentV1 incidentRoleAssignmentV1

var IncidentRoleV1 incidentRoleV1

var IncidentRoleV2 incidentRoleV2

var IncidentStatusV1 incidentStatusV1

var IncidentTimestampV2 incidentTimestampV2

var IncidentTimestampValueV2 incidentTimestampValueV2

var IncidentTimestampWithValueV2 incidentTimestampWithValueV2

var IncidentTypeV1 incidentTypeV1

var IncidentUpdateV2 incidentUpdateV2

var IncidentV2 incidentV2

var SeverityV2 severityV2

var UserV1 userV1

Functions

func DumpToMap

func DumpToMap(input interface{}) map[string]any

As a shortcut for simple leaf nodes we can just dump everything (we can also dump everything higher level probably too) If we're just going to dump everything why bother with serialisers? Good question. a) Initial thoughts were that we want some control on the fields we output potentially - for example ignoring deprecated fields. b) We also might need to be cleverer when it comes to catalog config that enables / disables optional fields in the output.

Keeping this as a single callsite so it's easy to find where we're doing this in future.

Types

type ArrayItem

type ArrayItem struct {
	Type       string              `json:"type"`
	Properties map[string]Property `json:"properties,omitempty"`
}

ArrayItem is the type and properties of an item in an array.

type Property

type Property struct {
	// Types is a list of types that this property can be, e.g. "string" or "integer".
	Types []string `json:"type"`
	// CustomFormat	is a custom format for this property, e.g. "date-time".
	CustomFormat string `json:"format,omitempty"`
	// For nested structures a property can have its own properties.
	Properties map[string]Property `json:"properties,omitempty"`
	// For array structures we define the type of the items in the array
	Items *ArrayItem `json:"items,omitempty"`
}

Property is a property in a JSON schema.

func ArrayOf

func ArrayOf(p Property) Property

func Optional

func Optional(p Property) Property

func (Property) IsBoolean

func (s Property) IsBoolean() bool

func (Property) IsDateTime

func (s Property) IsDateTime() bool

func (Property) IsInteger

func (s Property) IsInteger() bool

func (Property) IsNumber

func (s Property) IsNumber() bool

type Schema

type Schema struct {
	// Type is the type of the schema, e.g. "object" - for some reason singer docs
	// have this as an array and often nullable eg: `"type": ["null", "object"]`
	Type []string `json:"type"`
	// HasAdditionalProperties indicates whether the schema allows additional properties
	// not defined in the schema.
	HasAdditionalProperties bool `json:"additionalProperties"`
	// Properties is a map of property names to their schema.
	Properties map[string]Property `json:"properties"`
}

Schema is a JSON schema for a stream.