port

Documentation

Index

• type AccessTokenResponse
• type Action
• type ActionUserInputs
• type AggregatedResource
• type Blueprint
• type BlueprintAggregationProperty
• type BlueprintCalculationProperty
• type BlueprintMirrorProperty
• type BlueprintProperty
• type BlueprintSchema
• type ChangelogDestination
• type Config
• type Entity
• type EntityMapping
• type EntityMappings
• type EventListenerSettings
• type Integration
• type IntegrationAppConfig
• type InvocationMethod
• type KindConfig
• type Meta
• type OrgDetails
• type OrgKafkaCredentials
• type Port
• type Relation
• type Resource
• type ResponseBody
• type Rule
• type Scorecard
• type SearchBody
• type Selector

Types

type AccessTokenResponse

type AccessTokenResponse struct {
	Ok          bool   `json:"ok"`
	AccessToken string `json:"accessToken"`
	ExpiresIn   int64  `json:"expiresIn"`
	TokenType   string `json:"tokenType"`
}

type Action

type Action struct {
	ID               string            `json:"id,omitempty"`
	Identifier       string            `json:"identifier,omitempty"`
	Description      string            `json:"description,omitempty"`
	Title            string            `json:"title,omitempty"`
	Icon             string            `json:"icon,omitempty"`
	UserInputs       ActionUserInputs  `json:"userInputs"`
	Trigger          string            `json:"trigger"`
	InvocationMethod *InvocationMethod `json:"invocationMethod,omitempty"`
}

type ActionUserInputs

type ActionUserInputs = BlueprintSchema

type AggregatedResource

type AggregatedResource struct {
	Kind        string
	KindConfigs []KindConfig
}

type Blueprint

type Blueprint struct {
	Meta
	Identifier            string                                  `json:"identifier,omitempty"`
	Title                 string                                  `json:"title,omitempty"`
	Icon                  string                                  `json:"icon"`
	Description           string                                  `json:"description"`
	Schema                BlueprintSchema                         `json:"schema"`
	CalculationProperties map[string]BlueprintCalculationProperty `json:"calculationProperties,omitempty"`
	AggregationProperties map[string]BlueprintAggregationProperty `json:"aggregationProperties,omitempty"`
	MirrorProperties      map[string]BlueprintMirrorProperty      `json:"mirrorProperties,omitempty"`
	ChangelogDestination  *ChangelogDestination                   `json:"changelogDestination,omitempty"`
	Relations             map[string]Relation                     `json:"relations,omitempty"`
}

type BlueprintAggregationProperty

type BlueprintAggregationProperty struct {
	Title           string      `json:"title"`
	Target          string      `json:"target"`
	CalculationSpec interface{} `json:"calculationSpec"`
	Query           interface{} `json:"query,omitempty"`
	Description     string      `json:"description,omitempty"`
	Icon            string      `json:"icon,omitempty"`
	Type            string      `json:"type,omitempty"`
}

type BlueprintCalculationProperty

type BlueprintCalculationProperty struct {
	Identifier  string            `json:"identifier,omitempty"`
	Title       string            `json:"title,omitempty"`
	Calculation string            `json:"calculation,omitempty"`
	Colors      map[string]string `json:"colors,omitempty"`
	Colorized   bool              `json:"colorized,omitempty"`
	Format      string            `json:"format,omitempty"`
	Type        string            `json:"type,omitempty"`
}

type BlueprintMirrorProperty

type BlueprintMirrorProperty struct {
	Identifier string `json:"identifier,omitempty"`
	Title      string `json:"title,omitempty"`
	Path       string `json:"path,omitempty"`
}

type BlueprintProperty

type BlueprintProperty struct {
	Type        string            `json:"type,omitempty"`
	Title       string            `json:"title,omitempty"`
	Identifier  string            `json:"identifier,omitempty"`
	Default     any               `json:"default,omitempty"`
	Icon        string            `json:"icon,omitempty"`
	Format      string            `json:"format,omitempty"`
	Description string            `json:"description,omitempty"`
	Blueprint   string            `json:"blueprint,omitempty"`
	Pattern     string            `json:"pattern,omitempty"`
	Enum        []string          `json:"enum,omitempty"`
	EnumColors  map[string]string `json:"enumColors,omitempty"`
}

type BlueprintSchema

type BlueprintSchema struct {
	Properties map[string]BlueprintProperty `json:"properties"`
	Required   []string                     `json:"required,omitempty"`
}

type ChangelogDestination

type ChangelogDestination struct {
	Type string `json:"type,omitempty"`
	Url  string `json:"url,omitempty"`
}

type Config

type Config struct {
	ResyncInterval         uint
	StateKey               string
	EventListenerType      string
	CreateDefaultResources bool
	// Deprecated: use IntegrationAppConfig instead. Used for updating the Port integration config on startup.
	Resources []Resource `json:"resources,omitempty"`
	// Deprecated: use IntegrationAppConfig instead. Used for updating the Port integration config on startup.
	DeleteDependents bool `json:"deleteDependents,omitempty"`
	// Deprecated: use IntegrationAppConfig instead. Used for updating the Port integration config on startup.
	CreateMissingRelatedEntities bool `json:"createMissingRelatedEntities,omitempty"`
}

type Entity

type Entity struct {
	Meta
	Identifier string                 `json:"identifier,omitempty"`
	Title      string                 `json:"title"`
	Blueprint  string                 `json:"blueprint"`
	Team       interface{}            `json:"team,omitempty"`
	Properties map[string]interface{} `json:"properties"`
	Relations  map[string]interface{} `json:"relations"`
}

type EntityMapping

type EntityMapping struct {
	Identifier string            `json:"identifier"`
	Title      string            `json:"title"`
	Blueprint  string            `json:"blueprint"`
	Team       string            `json:"team,omitempty"`
	Properties map[string]string `json:"properties,omitempty"`
	Relations  map[string]string `json:"relations,omitempty"`
}

type EntityMappings

type EntityMappings struct {
	Mappings []EntityMapping `json:"mappings"`
}

type EventListenerSettings

type EventListenerSettings struct {
	Type string `json:"type,omitempty"`
}

type Integration

type Integration struct {
	InstallationId      string                 `json:"installationId,omitempty"`
	Title               string                 `json:"title,omitempty"`
	Version             string                 `json:"version,omitempty"`
	InstallationAppType string                 `json:"installationAppType,omitempty"`
	EventListener       *EventListenerSettings `json:"changelogDestination,omitempty"`
	Config              *IntegrationAppConfig  `json:"config,omitempty"`
	UpdatedAt           *time.Time             `json:"updatedAt,omitempty"`
}

type IntegrationAppConfig

type IntegrationAppConfig struct {
	DeleteDependents             bool       `json:"deleteDependents,omitempty"`
	CreateMissingRelatedEntities bool       `json:"createMissingRelatedEntities,omitempty"`
	Resources                    []Resource `json:"resources,omitempty"`
}

type InvocationMethod

type InvocationMethod struct {
	Type string `json:"type,omitempty"`
	Url  string `json:"url,omitempty"`
}

type KindConfig

type KindConfig struct {
	Selector Selector
	Port     Port
}

type Meta

type Meta struct {
	CreatedAt *time.Time `json:"createdAt,omitempty"`
	UpdatedAt *time.Time `json:"updatedAt,omitempty"`
	CreatedBy string     `json:"createdBy,omitempty"`
	UpdatedBy string     `json:"updatedBy,omitempty"`
}

type OrgDetails

type OrgDetails struct {
	OrgId string `json:"id"`
}

type OrgKafkaCredentials

type OrgKafkaCredentials struct {
	Username string `json:"username"`
	Password string `json:"password"`
}

type Port

type Port struct {
	Entity EntityMappings `json:"entity"`
}

type Relation

type Relation struct {
	Identifier string `json:"identifier,omitempty"`
	Title      string `json:"title,omitempty"`
	Target     string `json:"target,omitempty"`
	Required   bool   `json:"required,omitempty"`
	Many       bool   `json:"many,omitempty"`
}

type Resource

type Resource struct {
	Kind     string   `json:"kind"`
	Selector Selector `json:"selector,omitempty"`
	Port     Port     `json:"port"`
}

type ResponseBody

type ResponseBody struct {
	OK               bool                `json:"ok"`
	Entity           Entity              `json:"entity"`
	Blueprint        Blueprint           `json:"blueprint"`
	Action           Action              `json:"action"`
	Entities         []Entity            `json:"entities"`
	Integration      Integration         `json:"integration"`
	KafkaCredentials OrgKafkaCredentials `json:"credentials"`
	OrgDetails       OrgDetails          `json:"organization"`
	Scorecard        Scorecard           `json:"scorecard"`
}

type Rule

type Rule struct {
	Property string      `json:"property"`
	Operator string      `json:"operator"`
	Value    interface{} `json:"value"`
}

type Scorecard

type Scorecard struct {
	Identifier string        `json:"identifier,omitempty"`
	Title      string        `json:"title,omitempty"`
	Filter     interface{}   `json:"filter,omitempty"`
	Rules      []interface{} `json:"rules,omitempty"`
}

type SearchBody

type SearchBody struct {
	Rules      []Rule `json:"rules"`
	Combinator string `json:"combinator"`
}

type Selector

type Selector struct {
	Query string
}