models

Documentation

Index

• Constants
• type App
• type AppInstanceData
  • func (aic AppInstanceData) AppID() string
  • func (aic AppInstanceData) AppName() string
  • func (aic *AppInstanceData) MarshalFile(path string) error
  • func (aic *AppInstanceData) UnmarshalFile(path string) error
• type UserProfile
  • func (pd *UserProfile) AllGroupIDs() []string

Constants

const (
	AppIDField   string = "app_id"
	AppNameField string = "name"
)

App config field identifiers

const AppConfigFileName string = "stitch.json"

AppConfigFileName is the name of top-level config file describing the app

Types

type App

type App struct {
	ID          string `json:"_id"`
	GroupID     string `json:"group_id"`
	ClientAppID string `json:"client_app_id"`
	Name        string `json:"name"`
}

App represents basic Stitch App data

type AppInstanceData

type AppInstanceData map[string]interface{}

AppInstanceData defines data pertaining to a specific deployment of a Stitch application

func (AppInstanceData) AppID

func (aic AppInstanceData) AppID() string

AppID returns the app's Client App ID

func (AppInstanceData) AppName

func (aic AppInstanceData) AppName() string

AppName returns the app's user-defined name

func (*AppInstanceData) MarshalFile

func (aic *AppInstanceData) MarshalFile(path string) error

MarshalFile writes the AppInstanceData to the AppConfigFileName at the provided path

func (*AppInstanceData) UnmarshalFile

func (aic *AppInstanceData) UnmarshalFile(path string) error

UnmarshalFile unmarshals data from a local config file into an AppInstanceData

type UserProfile

type UserProfile struct {
	Roles []role `json:"roles"`
}

UserProfile holds basic metadata for a given user

func (*UserProfile) AllGroupIDs

func (pd *UserProfile) AllGroupIDs() []string

AllGroupIDs returns all available group ids for a given user