Documentation ¶
Index ¶
- Variables
- type ActionConfig
- func (*ActionConfig) Descriptor() ([]byte, []int)deprecated
- func (x *ActionConfig) GetActionName() string
- func (x *ActionConfig) GetActionType() proto.ActionType
- func (x *ActionConfig) GetApiNames() []string
- func (x *ActionConfig) GetCapabilities() *Capabilities
- func (x *ActionConfig) GetCreateEntryAction() *ActionLink
- func (x *ActionConfig) GetDisplayLayout() *DisplayLayoutConfig
- func (x *ActionConfig) GetEmbeddedTools() []*ToolGroup
- func (x *ActionConfig) GetEntityPlural() string
- func (x *ActionConfig) GetEntitySingle() string
- func (x *ActionConfig) GetEntryActivityActions() []*ActionLink
- func (x *ActionConfig) GetExternalLinks() []*ExternalLink
- func (x *ActionConfig) GetGetEntryAction() *ActionLink
- func (x *ActionConfig) GetHelpText() *StringTemplate
- func (x *ActionConfig) GetIcon() string
- func (x *ActionConfig) GetId() string
- func (x *ActionConfig) GetImplementation() proto.ActionImplementation
- func (x *ActionConfig) GetInputs() []*RequestFieldConfig
- func (x *ActionConfig) GetModelName() string
- func (x *ActionConfig) GetName() string
- func (x *ActionConfig) GetPagination() *CursorPaginationConfig
- func (x *ActionConfig) GetRelatedActions() []*ActionLink
- func (x *ActionConfig) GetResponse() []*ResponseFieldConfig
- func (x *ActionConfig) GetTitle() *StringTemplate
- func (*ActionConfig) ProtoMessage()
- func (x *ActionConfig) ProtoReflect() protoreflect.Message
- func (x *ActionConfig) Reset()
- func (x *ActionConfig) String() string
- type ActionLink
- func (*ActionLink) Descriptor() ([]byte, []int)deprecated
- func (x *ActionLink) GetAsDialog() bool
- func (x *ActionLink) GetData() []*DataMapping
- func (x *ActionLink) GetDescription() *StringTemplate
- func (x *ActionLink) GetDisplayOrder() int32
- func (x *ActionLink) GetId() string
- func (x *ActionLink) GetTitle() *StringTemplate
- func (x *ActionLink) GetToolId() string
- func (*ActionLink) ProtoMessage()
- func (x *ActionLink) ProtoReflect() protoreflect.Message
- func (x *ActionLink) Reset()
- func (x *ActionLink) String() string
- type BoardViewConfig
- func (*BoardViewConfig) Descriptor() ([]byte, []int)deprecated
- func (x *BoardViewConfig) GetAvatarEnabled() bool
- func (x *BoardViewConfig) GetAvatarFallback() *StringTemplate
- func (x *BoardViewConfig) GetAvatarUrl() *StringTemplate
- func (x *BoardViewConfig) GetContextField() *StringTemplate
- func (x *BoardViewConfig) GetDescription() *StringTemplate
- func (x *BoardViewConfig) GetGetTool() *ActionLink
- func (x *BoardViewConfig) GetGroupByField() *JsonPath
- func (x *BoardViewConfig) GetTitle() *StringTemplate
- func (x *BoardViewConfig) GetUpdateAction() *ActionLink
- func (*BoardViewConfig) ProtoMessage()
- func (x *BoardViewConfig) ProtoReflect() protoreflect.Message
- func (x *BoardViewConfig) Reset()
- func (x *BoardViewConfig) String() string
- type Capabilities
- func (*Capabilities) Descriptor() ([]byte, []int)deprecated
- func (x *Capabilities) GetAudit() bool
- func (x *Capabilities) GetComments() bool
- func (*Capabilities) ProtoMessage()
- func (x *Capabilities) ProtoReflect() protoreflect.Message
- func (x *Capabilities) Reset()
- func (x *Capabilities) String() string
- type CursorPaginationConfig
- func (*CursorPaginationConfig) Descriptor() ([]byte, []int)deprecated
- func (x *CursorPaginationConfig) GetEnd() *CursorPaginationConfig_FieldConfig
- func (x *CursorPaginationConfig) GetNextPage() *JsonPath
- func (x *CursorPaginationConfig) GetPageSize() *CursorPaginationConfig_PageSizeConfig
- func (x *CursorPaginationConfig) GetStart() *CursorPaginationConfig_FieldConfig
- func (x *CursorPaginationConfig) GetTotalCount() *JsonPath
- func (*CursorPaginationConfig) ProtoMessage()
- func (x *CursorPaginationConfig) ProtoReflect() protoreflect.Message
- func (x *CursorPaginationConfig) Reset()
- func (x *CursorPaginationConfig) String() string
- type CursorPaginationConfig_FieldConfig
- func (*CursorPaginationConfig_FieldConfig) Descriptor() ([]byte, []int)deprecated
- func (x *CursorPaginationConfig_FieldConfig) GetRequestInput() string
- func (x *CursorPaginationConfig_FieldConfig) GetResponseField() *JsonPath
- func (*CursorPaginationConfig_FieldConfig) ProtoMessage()
- func (x *CursorPaginationConfig_FieldConfig) ProtoReflect() protoreflect.Message
- func (x *CursorPaginationConfig_FieldConfig) Reset()
- func (x *CursorPaginationConfig_FieldConfig) String() string
- type CursorPaginationConfig_PageSizeConfig
- func (*CursorPaginationConfig_PageSizeConfig) Descriptor() ([]byte, []int)deprecated
- func (x *CursorPaginationConfig_PageSizeConfig) GetDefaultValue() int32
- func (x *CursorPaginationConfig_PageSizeConfig) GetRequestInput() string
- func (x *CursorPaginationConfig_PageSizeConfig) GetResponseField() *JsonPath
- func (*CursorPaginationConfig_PageSizeConfig) ProtoMessage()
- func (x *CursorPaginationConfig_PageSizeConfig) ProtoReflect() protoreflect.Message
- func (x *CursorPaginationConfig_PageSizeConfig) Reset()
- func (x *CursorPaginationConfig_PageSizeConfig) String() string
- type DataMapping
- func (*DataMapping) Descriptor() ([]byte, []int)deprecated
- func (x *DataMapping) GetKey() string
- func (x *DataMapping) GetObject() []*DataMapping
- func (x *DataMapping) GetPath() *JsonPath
- func (x *DataMapping) GetValue() *ScalarValue
- func (*DataMapping) ProtoMessage()
- func (x *DataMapping) ProtoReflect() protoreflect.Message
- func (x *DataMapping) Reset()
- func (x *DataMapping) String() string
- type DisplayLayoutConfig
- func (*DisplayLayoutConfig) Descriptor() ([]byte, []int)deprecated
- func (x *DisplayLayoutConfig) GetBoardConfig() *BoardViewConfig
- func (x *DisplayLayoutConfig) GetGridConfig() *GridViewConfig
- func (x *DisplayLayoutConfig) GetInboxConfig() *InboxViewConfig
- func (x *DisplayLayoutConfig) GetType() DisplayLayoutConfig_Type
- func (*DisplayLayoutConfig) ProtoMessage()
- func (x *DisplayLayoutConfig) ProtoReflect() protoreflect.Message
- func (x *DisplayLayoutConfig) Reset()
- func (x *DisplayLayoutConfig) String() string
- type DisplayLayoutConfig_Type
- func (DisplayLayoutConfig_Type) Descriptor() protoreflect.EnumDescriptor
- func (x DisplayLayoutConfig_Type) Enum() *DisplayLayoutConfig_Type
- func (DisplayLayoutConfig_Type) EnumDescriptor() ([]byte, []int)deprecated
- func (x DisplayLayoutConfig_Type) Number() protoreflect.EnumNumber
- func (x DisplayLayoutConfig_Type) String() string
- func (DisplayLayoutConfig_Type) Type() protoreflect.EnumType
- type ExternalLink
- func (*ExternalLink) Descriptor() ([]byte, []int)deprecated
- func (x *ExternalLink) GetDisplayOrder() int32
- func (x *ExternalLink) GetHref() *StringTemplate
- func (x *ExternalLink) GetIcon() string
- func (x *ExternalLink) GetLabel() *StringTemplate
- func (*ExternalLink) ProtoMessage()
- func (x *ExternalLink) ProtoReflect() protoreflect.Message
- func (x *ExternalLink) Reset()
- func (x *ExternalLink) String() string
- type GridViewConfig
- type InboxViewConfig
- func (*InboxViewConfig) Descriptor() ([]byte, []int)deprecated
- func (x *InboxViewConfig) GetAvatarEnabled() bool
- func (x *InboxViewConfig) GetAvatarFallback() *StringTemplate
- func (x *InboxViewConfig) GetAvatarUrl() *StringTemplate
- func (x *InboxViewConfig) GetContextField() *StringTemplate
- func (x *InboxViewConfig) GetDescription() *StringTemplate
- func (x *InboxViewConfig) GetGetTool() *ActionLink
- func (x *InboxViewConfig) GetTitle() *StringTemplate
- func (*InboxViewConfig) ProtoMessage()
- func (x *InboxViewConfig) ProtoReflect() protoreflect.Message
- func (x *InboxViewConfig) Reset()
- func (x *InboxViewConfig) String() string
- type JsonPath
- type RequestFieldConfig
- func (*RequestFieldConfig) Descriptor() ([]byte, []int)deprecated
- func (x *RequestFieldConfig) GetDefaultValue() *ScalarValue
- func (x *RequestFieldConfig) GetDisplayName() string
- func (x *RequestFieldConfig) GetDisplayOrder() int32
- func (x *RequestFieldConfig) GetEnumName() string
- func (x *RequestFieldConfig) GetFieldLocation() *JsonPath
- func (x *RequestFieldConfig) GetFieldName() string
- func (x *RequestFieldConfig) GetFieldType() proto.Type
- func (x *RequestFieldConfig) GetGetEntryAction() *ActionLink
- func (x *RequestFieldConfig) GetHelpText() *StringTemplate
- func (x *RequestFieldConfig) GetId() string
- func (x *RequestFieldConfig) GetLocked() bool
- func (x *RequestFieldConfig) GetLookupAction() *ActionLink
- func (x *RequestFieldConfig) GetModelName() string
- func (x *RequestFieldConfig) GetPlaceholder() *StringTemplate
- func (x *RequestFieldConfig) GetRepeated() bool
- func (x *RequestFieldConfig) GetScope() RequestFieldConfig_ScopeType
- func (x *RequestFieldConfig) GetVisible() bool
- func (*RequestFieldConfig) ProtoMessage()
- func (x *RequestFieldConfig) ProtoReflect() protoreflect.Message
- func (x *RequestFieldConfig) Reset()
- func (x *RequestFieldConfig) String() string
- type RequestFieldConfig_ScopeType
- func (RequestFieldConfig_ScopeType) Descriptor() protoreflect.EnumDescriptor
- func (x RequestFieldConfig_ScopeType) Enum() *RequestFieldConfig_ScopeType
- func (RequestFieldConfig_ScopeType) EnumDescriptor() ([]byte, []int)deprecated
- func (x RequestFieldConfig_ScopeType) Number() protoreflect.EnumNumber
- func (x RequestFieldConfig_ScopeType) String() string
- func (RequestFieldConfig_ScopeType) Type() protoreflect.EnumType
- type ResponseFieldConfig
- func (*ResponseFieldConfig) Descriptor() ([]byte, []int)deprecated
- func (x *ResponseFieldConfig) GetDisplayName() string
- func (x *ResponseFieldConfig) GetDisplayOrder() int32
- func (x *ResponseFieldConfig) GetEnumName() string
- func (x *ResponseFieldConfig) GetFieldLocation() *JsonPath
- func (x *ResponseFieldConfig) GetFieldName() string
- func (x *ResponseFieldConfig) GetFieldType() proto.Type
- func (x *ResponseFieldConfig) GetHelpText() *StringTemplate
- func (x *ResponseFieldConfig) GetId() string
- func (x *ResponseFieldConfig) GetImagePreview() bool
- func (x *ResponseFieldConfig) GetLink() *ActionLink
- func (x *ResponseFieldConfig) GetModelName() string
- func (x *ResponseFieldConfig) GetRepeated() bool
- func (x *ResponseFieldConfig) GetScope() ResponseFieldConfig_ScopeType
- func (x *ResponseFieldConfig) GetSortable() bool
- func (x *ResponseFieldConfig) GetVisible() bool
- func (*ResponseFieldConfig) ProtoMessage()
- func (x *ResponseFieldConfig) ProtoReflect() protoreflect.Message
- func (x *ResponseFieldConfig) Reset()
- func (x *ResponseFieldConfig) String() string
- type ResponseFieldConfig_ScopeType
- func (ResponseFieldConfig_ScopeType) Descriptor() protoreflect.EnumDescriptor
- func (x ResponseFieldConfig_ScopeType) Enum() *ResponseFieldConfig_ScopeType
- func (ResponseFieldConfig_ScopeType) EnumDescriptor() ([]byte, []int)deprecated
- func (x ResponseFieldConfig_ScopeType) Number() protoreflect.EnumNumber
- func (x ResponseFieldConfig_ScopeType) String() string
- func (ResponseFieldConfig_ScopeType) Type() protoreflect.EnumType
- type ResponseOverrides
- func (*ResponseOverrides) Descriptor() ([]byte, []int)deprecated
- func (x *ResponseOverrides) GetFieldLocation() *JsonPath
- func (x *ResponseOverrides) GetVisible() bool
- func (*ResponseOverrides) ProtoMessage()
- func (x *ResponseOverrides) ProtoReflect() protoreflect.Message
- func (x *ResponseOverrides) Reset()
- func (x *ResponseOverrides) String() string
- type ScalarValue
- func (*ScalarValue) Descriptor() ([]byte, []int)deprecated
- func (x *ScalarValue) GetBool() bool
- func (x *ScalarValue) GetFloat() float32
- func (x *ScalarValue) GetInteger() int32
- func (x *ScalarValue) GetNull() bool
- func (x *ScalarValue) GetString_() string
- func (m *ScalarValue) GetValue() isScalarValue_Value
- func (*ScalarValue) ProtoMessage()
- func (x *ScalarValue) ProtoReflect() protoreflect.Message
- func (x *ScalarValue) Reset()
- func (x *ScalarValue) String() string
- type ScalarValue_Bool
- type ScalarValue_Float
- type ScalarValue_Integer
- type ScalarValue_Null
- type ScalarValue_String_
- type StringTemplate
- func (*StringTemplate) Descriptor() ([]byte, []int)deprecated
- func (x *StringTemplate) GetMarkdown() bool
- func (x *StringTemplate) GetTemplate() string
- func (*StringTemplate) ProtoMessage()
- func (x *StringTemplate) ProtoReflect() protoreflect.Message
- func (x *StringTemplate) Reset()
- func (x *StringTemplate) String() string
- type ToolGroup
- func (*ToolGroup) Descriptor() ([]byte, []int)deprecated
- func (x *ToolGroup) GetDisplayOrder() int32
- func (x *ToolGroup) GetId() string
- func (x *ToolGroup) GetTitle() *StringTemplate
- func (x *ToolGroup) GetTools() []*ToolGroup_GroupActionLink
- func (x *ToolGroup) GetVisible() bool
- func (*ToolGroup) ProtoMessage()
- func (x *ToolGroup) ProtoReflect() protoreflect.Message
- func (x *ToolGroup) Reset()
- func (x *ToolGroup) String() string
- type ToolGroup_GroupActionLink
- func (*ToolGroup_GroupActionLink) Descriptor() ([]byte, []int)deprecated
- func (x *ToolGroup_GroupActionLink) GetActionLink() *ActionLink
- func (x *ToolGroup_GroupActionLink) GetResponseOverrides() []*ResponseOverrides
- func (*ToolGroup_GroupActionLink) ProtoMessage()
- func (x *ToolGroup_GroupActionLink) ProtoReflect() protoreflect.Message
- func (x *ToolGroup_GroupActionLink) Reset()
- func (x *ToolGroup_GroupActionLink) String() string
Constants ¶
This section is empty.
Variables ¶
var ( RequestFieldConfig_ScopeType_name = map[int32]string{ 0: "DEFAULT", 1: "PAGINATION", 2: "FILTERS", 3: "SORTING", } RequestFieldConfig_ScopeType_value = map[string]int32{ "DEFAULT": 0, "PAGINATION": 1, "FILTERS": 2, "SORTING": 3, } )
Enum value maps for RequestFieldConfig_ScopeType.
var ( ResponseFieldConfig_ScopeType_name = map[int32]string{ 0: "DEFAULT", 1: "PAGINATION", } ResponseFieldConfig_ScopeType_value = map[string]int32{ "DEFAULT": 0, "PAGINATION": 1, } )
Enum value maps for ResponseFieldConfig_ScopeType.
var ( DisplayLayoutConfig_Type_name = map[int32]string{ 0: "UNKNOWN", 1: "INBOX", 2: "BOARD", 3: "GRID", } DisplayLayoutConfig_Type_value = map[string]int32{ "UNKNOWN": 0, "INBOX": 1, "BOARD": 2, "GRID": 3, } )
Enum value maps for DisplayLayoutConfig_Type.
var File_tools_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type ActionConfig ¶
type ActionConfig struct { // A slug identifier for this tool used to reference it regardless of the build/environment; // E.g. get-order, or get-order-2 Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // Sentence case the action name e.g "Get order" Name string `protobuf:"bytes,2,opt,name=name,proto3" json:"name,omitempty"` // Skipped for auto generated tools Icon *string `protobuf:"bytes,3,opt,name=icon,proto3,oneof" json:"icon,omitempty"` // The action in the schema e.g "getOrder" ActionName string `protobuf:"bytes,4,opt,name=action_name,json=actionName,proto3" json:"action_name,omitempty"` // The names of the APIs in which this action sits ApiNames []string `protobuf:"bytes,5,rep,name=api_names,json=apiNames,proto3" json:"api_names,omitempty"` // The name of the model on which this tool operates on. ModelName string `protobuf:"bytes,6,opt,name=model_name,json=modelName,proto3" json:"model_name,omitempty"` ActionType proto.ActionType `protobuf:"varint,7,opt,name=action_type,json=actionType,proto3,enum=proto.ActionType" json:"action_type,omitempty"` Implementation proto.ActionImplementation `protobuf:"varint,8,opt,name=implementation,proto3,enum=proto.ActionImplementation" json:"implementation,omitempty"` Inputs []*RequestFieldConfig `protobuf:"bytes,9,rep,name=inputs,proto3" json:"inputs,omitempty"` Response []*ResponseFieldConfig `protobuf:"bytes,10,rep,name=response,proto3" json:"response,omitempty"` // Title of the tool. // Default value: a template with the first field of the model if it's a text field, // otherwise empty. Title *StringTemplate `protobuf:"bytes,11,opt,name=title,proto3,oneof" json:"title,omitempty"` // Template language support: markdown HelpText *StringTemplate `protobuf:"bytes,12,opt,name=help_text,json=helpText,proto3,oneof" json:"help_text,omitempty"` // The name of the entity associated with this tool, in a singular form (e.g. order, user). // The word is lowercased; for generated tools it is the name of the model EntitySingle string `protobuf:"bytes,13,opt,name=entity_single,json=entitySingle,proto3" json:"entity_single,omitempty"` // The name of the entity associated with this tool, in a plural form (e.g. orders, users). // The word is lowercased; for generated tools it is derived from name of the model EntityPlural string `protobuf:"bytes,14,opt,name=entity_plural,json=entityPlural,proto3" json:"entity_plural,omitempty"` // What features are enabled for this tool Capabilities *Capabilities `protobuf:"bytes,15,opt,name=capabilities,proto3" json:"capabilities,omitempty"` // A list of ... list actions, aka views. // E.g. For a listOrders action; these would be tabs that show filtered orders by status // (Processed, Pending, Completed) // For auto-generated configs, this is only populated for: // - list actions, with links to other list actions for the same model. // - delete actions, with links to all list actions for the same model. RelatedActions []*ActionLink `protobuf:"bytes,16,rep,name=related_actions,json=relatedActions,proto3" json:"related_actions,omitempty"` // Only for List actions; Support offset and cursor Pagination *CursorPaginationConfig `protobuf:"bytes,17,opt,name=pagination,proto3,oneof" json:"pagination,omitempty"` // List of extenal links that will be displayed with this tool; used only for Get actions. // Nothing for auto generated ExternalLinks []*ExternalLink `protobuf:"bytes,18,rep,name=external_links,json=externalLinks,proto3" json:"external_links,omitempty"` // Things you can do to this entry // All update, deletes, creates, read and write on the same model. // Only for List & Get; empty for mutations EntryActivityActions []*ActionLink `protobuf:"bytes,19,rep,name=entry_activity_actions,json=entryActivityActions,proto3" json:"entry_activity_actions,omitempty"` // The action to use to get an entry on this model. Default to a get action on the same model // Used for: // - fetching the record for prefilling a mutation // - the link for clicking a row in a List // - the action to call after a mutation GetEntryAction *ActionLink `protobuf:"bytes,21,opt,name=get_entry_action,json=getEntryAction,proto3,oneof" json:"get_entry_action,omitempty"` // The action to use to create a new entry for this model. By default, this action link will be created // for LIST and GET actions in the case where a CREATE action exists for the same model. It should // be used to add a button on the tool to `Create a new/another record` CreateEntryAction *ActionLink `protobuf:"bytes,22,opt,name=create_entry_action,json=createEntryAction,proto3,oneof" json:"create_entry_action,omitempty"` // Embeded action groups are tools that will be displayed inline (embedded) withing the one that // we're defining. These tools will be rendered within this action's configuration, and can have // specific config overrides. EmbeddedTools []*ToolGroup `protobuf:"bytes,23,rep,name=embedded_tools,json=embeddedTools,proto3" json:"embedded_tools,omitempty"` // Configuration for different views that are enabled for this tool. A tool can be configured to be // displayable in multiple types of views, for example, as a table, as an email inbox, or a kanban // board. Each view will require specific configuration, these are supplied as part of the // DisplayLayoutConfig message. DisplayLayout *DisplayLayoutConfig `protobuf:"bytes,24,opt,name=display_layout,json=displayLayout,proto3" json:"display_layout,omitempty"` // contains filtered or unexported fields }
func (*ActionConfig) Descriptor
deprecated
func (*ActionConfig) Descriptor() ([]byte, []int)
Deprecated: Use ActionConfig.ProtoReflect.Descriptor instead.
func (*ActionConfig) GetActionName ¶
func (x *ActionConfig) GetActionName() string
func (*ActionConfig) GetActionType ¶
func (x *ActionConfig) GetActionType() proto.ActionType
func (*ActionConfig) GetApiNames ¶
func (x *ActionConfig) GetApiNames() []string
func (*ActionConfig) GetCapabilities ¶
func (x *ActionConfig) GetCapabilities() *Capabilities
func (*ActionConfig) GetCreateEntryAction ¶ added in v0.395.9
func (x *ActionConfig) GetCreateEntryAction() *ActionLink
func (*ActionConfig) GetDisplayLayout ¶ added in v0.396.0
func (x *ActionConfig) GetDisplayLayout() *DisplayLayoutConfig
func (*ActionConfig) GetEmbeddedTools ¶ added in v0.395.14
func (x *ActionConfig) GetEmbeddedTools() []*ToolGroup
func (*ActionConfig) GetEntityPlural ¶
func (x *ActionConfig) GetEntityPlural() string
func (*ActionConfig) GetEntitySingle ¶
func (x *ActionConfig) GetEntitySingle() string
func (*ActionConfig) GetEntryActivityActions ¶
func (x *ActionConfig) GetEntryActivityActions() []*ActionLink
func (*ActionConfig) GetExternalLinks ¶ added in v0.395.9
func (x *ActionConfig) GetExternalLinks() []*ExternalLink
func (*ActionConfig) GetGetEntryAction ¶
func (x *ActionConfig) GetGetEntryAction() *ActionLink
func (*ActionConfig) GetHelpText ¶
func (x *ActionConfig) GetHelpText() *StringTemplate
func (*ActionConfig) GetIcon ¶
func (x *ActionConfig) GetIcon() string
func (*ActionConfig) GetId ¶
func (x *ActionConfig) GetId() string
func (*ActionConfig) GetImplementation ¶
func (x *ActionConfig) GetImplementation() proto.ActionImplementation
func (*ActionConfig) GetInputs ¶
func (x *ActionConfig) GetInputs() []*RequestFieldConfig
func (*ActionConfig) GetModelName ¶
func (x *ActionConfig) GetModelName() string
func (*ActionConfig) GetName ¶
func (x *ActionConfig) GetName() string
func (*ActionConfig) GetPagination ¶
func (x *ActionConfig) GetPagination() *CursorPaginationConfig
func (*ActionConfig) GetRelatedActions ¶
func (x *ActionConfig) GetRelatedActions() []*ActionLink
func (*ActionConfig) GetResponse ¶
func (x *ActionConfig) GetResponse() []*ResponseFieldConfig
func (*ActionConfig) GetTitle ¶
func (x *ActionConfig) GetTitle() *StringTemplate
func (*ActionConfig) ProtoMessage ¶
func (*ActionConfig) ProtoMessage()
func (*ActionConfig) ProtoReflect ¶
func (x *ActionConfig) ProtoReflect() protoreflect.Message
func (*ActionConfig) Reset ¶
func (x *ActionConfig) Reset()
func (*ActionConfig) String ¶
func (x *ActionConfig) String() string
type ActionLink ¶
type ActionLink struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` ToolId string `protobuf:"bytes,2,opt,name=tool_id,json=toolId,proto3" json:"tool_id,omitempty"` // The shape of this data is the input for the target action (i.e. 'where' and not 'values') but // with JSON paths for field values. Is a full object tree // e.g. // // { // "where": { // "id": "$.id" // JSON path on the current action repsonse. Can be recursive // } // } Data []*DataMapping `protobuf:"bytes,3,rep,name=data,proto3" json:"data,omitempty"` // Title/label to be displayed as part of the link/button created for this action link. Title *StringTemplate `protobuf:"bytes,4,opt,name=title,proto3,oneof" json:"title,omitempty"` // Empty by default // An optional string template which is to be displayed as a description/tagline for this link. Description *StringTemplate `protobuf:"bytes,5,opt,name=description,proto3,oneof" json:"description,omitempty"` // Empty by default // When the link is used within a list of action links, this field will be used to order items. DisplayOrder int32 `protobuf:"varint,6,opt,name=display_order,json=displayOrder,proto3" json:"display_order,omitempty"` // If this link should be opened up as a dialog/modal. AsDialog *bool `protobuf:"varint,7,opt,name=as_dialog,json=asDialog,proto3,oneof" json:"as_dialog,omitempty"` // contains filtered or unexported fields }
func (*ActionLink) Descriptor
deprecated
func (*ActionLink) Descriptor() ([]byte, []int)
Deprecated: Use ActionLink.ProtoReflect.Descriptor instead.
func (*ActionLink) GetAsDialog ¶ added in v0.397.3
func (x *ActionLink) GetAsDialog() bool
func (*ActionLink) GetData ¶
func (x *ActionLink) GetData() []*DataMapping
func (*ActionLink) GetDescription ¶ added in v0.395.12
func (x *ActionLink) GetDescription() *StringTemplate
func (*ActionLink) GetDisplayOrder ¶ added in v0.395.12
func (x *ActionLink) GetDisplayOrder() int32
func (*ActionLink) GetId ¶
func (x *ActionLink) GetId() string
func (*ActionLink) GetTitle ¶
func (x *ActionLink) GetTitle() *StringTemplate
func (*ActionLink) GetToolId ¶
func (x *ActionLink) GetToolId() string
func (*ActionLink) ProtoMessage ¶
func (*ActionLink) ProtoMessage()
func (*ActionLink) ProtoReflect ¶
func (x *ActionLink) ProtoReflect() protoreflect.Message
func (*ActionLink) Reset ¶
func (x *ActionLink) Reset()
func (*ActionLink) String ¶
func (x *ActionLink) String() string
type BoardViewConfig ¶ added in v0.397.3
type BoardViewConfig struct { // A link to a get action that will be used when the item is expanded GetTool *ActionLink `protobuf:"bytes,1,opt,name=get_tool,json=getTool,proto3" json:"get_tool,omitempty"` // The primary content of the card Title *StringTemplate `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"` // The secondary content of the card Description *StringTemplate `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` // Content to be displayed in the right hand side of the card ContextField *StringTemplate `protobuf:"bytes,4,opt,name=context_field,json=contextField,proto3,oneof" json:"context_field,omitempty"` // If an avatar/image is to be displayed with every card AvatarEnabled bool `protobuf:"varint,5,opt,name=avatar_enabled,json=avatarEnabled,proto3" json:"avatar_enabled,omitempty"` // URL for the image. AvatarUrl *StringTemplate `protobuf:"bytes,6,opt,name=avatar_url,json=avatarUrl,proto3,oneof" json:"avatar_url,omitempty"` AvatarFallback *StringTemplate `protobuf:"bytes,7,opt,name=avatar_fallback,json=avatarFallback,proto3,oneof" json:"avatar_fallback,omitempty"` // The response field that will be used to group items within swimlanes GroupByField *JsonPath `protobuf:"bytes,8,opt,name=group_by_field,json=groupByField,proto3" json:"group_by_field,omitempty"` // An optional update action that will be used when an item will move between swimlanes UpdateAction *ActionLink `protobuf:"bytes,9,opt,name=update_action,json=updateAction,proto3,oneof" json:"update_action,omitempty"` // contains filtered or unexported fields }
A kanban-like board display for list views. Each item in a list will be displayed as a card within swimlanes generated by a group_by_field
func (*BoardViewConfig) Descriptor
deprecated
added in
v0.397.3
func (*BoardViewConfig) Descriptor() ([]byte, []int)
Deprecated: Use BoardViewConfig.ProtoReflect.Descriptor instead.
func (*BoardViewConfig) GetAvatarEnabled ¶ added in v0.397.3
func (x *BoardViewConfig) GetAvatarEnabled() bool
func (*BoardViewConfig) GetAvatarFallback ¶ added in v0.397.3
func (x *BoardViewConfig) GetAvatarFallback() *StringTemplate
func (*BoardViewConfig) GetAvatarUrl ¶ added in v0.397.3
func (x *BoardViewConfig) GetAvatarUrl() *StringTemplate
func (*BoardViewConfig) GetContextField ¶ added in v0.397.3
func (x *BoardViewConfig) GetContextField() *StringTemplate
func (*BoardViewConfig) GetDescription ¶ added in v0.397.3
func (x *BoardViewConfig) GetDescription() *StringTemplate
func (*BoardViewConfig) GetGetTool ¶ added in v0.397.3
func (x *BoardViewConfig) GetGetTool() *ActionLink
func (*BoardViewConfig) GetGroupByField ¶ added in v0.397.3
func (x *BoardViewConfig) GetGroupByField() *JsonPath
func (*BoardViewConfig) GetTitle ¶ added in v0.397.3
func (x *BoardViewConfig) GetTitle() *StringTemplate
func (*BoardViewConfig) GetUpdateAction ¶ added in v0.397.3
func (x *BoardViewConfig) GetUpdateAction() *ActionLink
func (*BoardViewConfig) ProtoMessage ¶ added in v0.397.3
func (*BoardViewConfig) ProtoMessage()
func (*BoardViewConfig) ProtoReflect ¶ added in v0.397.3
func (x *BoardViewConfig) ProtoReflect() protoreflect.Message
func (*BoardViewConfig) Reset ¶ added in v0.397.3
func (x *BoardViewConfig) Reset()
func (*BoardViewConfig) String ¶ added in v0.397.3
func (x *BoardViewConfig) String() string
type Capabilities ¶
type Capabilities struct { Comments bool `protobuf:"varint,1,opt,name=comments,proto3" json:"comments,omitempty"` Audit bool `protobuf:"varint,2,opt,name=audit,proto3" json:"audit,omitempty"` // contains filtered or unexported fields }
func (*Capabilities) Descriptor
deprecated
func (*Capabilities) Descriptor() ([]byte, []int)
Deprecated: Use Capabilities.ProtoReflect.Descriptor instead.
func (*Capabilities) GetAudit ¶
func (x *Capabilities) GetAudit() bool
func (*Capabilities) GetComments ¶
func (x *Capabilities) GetComments() bool
func (*Capabilities) ProtoMessage ¶
func (*Capabilities) ProtoMessage()
func (*Capabilities) ProtoReflect ¶
func (x *Capabilities) ProtoReflect() protoreflect.Message
func (*Capabilities) Reset ¶
func (x *Capabilities) Reset()
func (*Capabilities) String ¶
func (x *Capabilities) String() string
type CursorPaginationConfig ¶
type CursorPaginationConfig struct { Start *CursorPaginationConfig_FieldConfig `protobuf:"bytes,1,opt,name=start,proto3" json:"start,omitempty"` End *CursorPaginationConfig_FieldConfig `protobuf:"bytes,2,opt,name=end,proto3" json:"end,omitempty"` PageSize *CursorPaginationConfig_PageSizeConfig `protobuf:"bytes,3,opt,name=page_size,json=pageSize,proto3" json:"page_size,omitempty"` NextPage *JsonPath `protobuf:"bytes,4,opt,name=next_page,json=nextPage,proto3" json:"next_page,omitempty"` TotalCount *JsonPath `protobuf:"bytes,5,opt,name=total_count,json=totalCount,proto3" json:"total_count,omitempty"` // contains filtered or unexported fields }
func (*CursorPaginationConfig) Descriptor
deprecated
func (*CursorPaginationConfig) Descriptor() ([]byte, []int)
Deprecated: Use CursorPaginationConfig.ProtoReflect.Descriptor instead.
func (*CursorPaginationConfig) GetEnd ¶
func (x *CursorPaginationConfig) GetEnd() *CursorPaginationConfig_FieldConfig
func (*CursorPaginationConfig) GetNextPage ¶
func (x *CursorPaginationConfig) GetNextPage() *JsonPath
func (*CursorPaginationConfig) GetPageSize ¶
func (x *CursorPaginationConfig) GetPageSize() *CursorPaginationConfig_PageSizeConfig
func (*CursorPaginationConfig) GetStart ¶
func (x *CursorPaginationConfig) GetStart() *CursorPaginationConfig_FieldConfig
func (*CursorPaginationConfig) GetTotalCount ¶
func (x *CursorPaginationConfig) GetTotalCount() *JsonPath
func (*CursorPaginationConfig) ProtoMessage ¶
func (*CursorPaginationConfig) ProtoMessage()
func (*CursorPaginationConfig) ProtoReflect ¶
func (x *CursorPaginationConfig) ProtoReflect() protoreflect.Message
func (*CursorPaginationConfig) Reset ¶
func (x *CursorPaginationConfig) Reset()
func (*CursorPaginationConfig) String ¶
func (x *CursorPaginationConfig) String() string
type CursorPaginationConfig_FieldConfig ¶
type CursorPaginationConfig_FieldConfig struct { RequestInput string `protobuf:"bytes,1,opt,name=request_input,json=requestInput,proto3" json:"request_input,omitempty"` ResponseField *JsonPath `protobuf:"bytes,2,opt,name=response_field,json=responseField,proto3" json:"response_field,omitempty"` // contains filtered or unexported fields }
TBD
func (*CursorPaginationConfig_FieldConfig) Descriptor
deprecated
func (*CursorPaginationConfig_FieldConfig) Descriptor() ([]byte, []int)
Deprecated: Use CursorPaginationConfig_FieldConfig.ProtoReflect.Descriptor instead.
func (*CursorPaginationConfig_FieldConfig) GetRequestInput ¶
func (x *CursorPaginationConfig_FieldConfig) GetRequestInput() string
func (*CursorPaginationConfig_FieldConfig) GetResponseField ¶
func (x *CursorPaginationConfig_FieldConfig) GetResponseField() *JsonPath
func (*CursorPaginationConfig_FieldConfig) ProtoMessage ¶
func (*CursorPaginationConfig_FieldConfig) ProtoMessage()
func (*CursorPaginationConfig_FieldConfig) ProtoReflect ¶
func (x *CursorPaginationConfig_FieldConfig) ProtoReflect() protoreflect.Message
func (*CursorPaginationConfig_FieldConfig) Reset ¶
func (x *CursorPaginationConfig_FieldConfig) Reset()
func (*CursorPaginationConfig_FieldConfig) String ¶
func (x *CursorPaginationConfig_FieldConfig) String() string
type CursorPaginationConfig_PageSizeConfig ¶
type CursorPaginationConfig_PageSizeConfig struct { RequestInput string `protobuf:"bytes,1,opt,name=request_input,json=requestInput,proto3" json:"request_input,omitempty"` ResponseField *JsonPath `protobuf:"bytes,2,opt,name=response_field,json=responseField,proto3" json:"response_field,omitempty"` DefaultValue int32 `protobuf:"varint,3,opt,name=default_value,json=defaultValue,proto3" json:"default_value,omitempty"` // contains filtered or unexported fields }
func (*CursorPaginationConfig_PageSizeConfig) Descriptor
deprecated
func (*CursorPaginationConfig_PageSizeConfig) Descriptor() ([]byte, []int)
Deprecated: Use CursorPaginationConfig_PageSizeConfig.ProtoReflect.Descriptor instead.
func (*CursorPaginationConfig_PageSizeConfig) GetDefaultValue ¶
func (x *CursorPaginationConfig_PageSizeConfig) GetDefaultValue() int32
func (*CursorPaginationConfig_PageSizeConfig) GetRequestInput ¶
func (x *CursorPaginationConfig_PageSizeConfig) GetRequestInput() string
func (*CursorPaginationConfig_PageSizeConfig) GetResponseField ¶
func (x *CursorPaginationConfig_PageSizeConfig) GetResponseField() *JsonPath
func (*CursorPaginationConfig_PageSizeConfig) ProtoMessage ¶
func (*CursorPaginationConfig_PageSizeConfig) ProtoMessage()
func (*CursorPaginationConfig_PageSizeConfig) ProtoReflect ¶
func (x *CursorPaginationConfig_PageSizeConfig) ProtoReflect() protoreflect.Message
func (*CursorPaginationConfig_PageSizeConfig) Reset ¶
func (x *CursorPaginationConfig_PageSizeConfig) Reset()
func (*CursorPaginationConfig_PageSizeConfig) String ¶
func (x *CursorPaginationConfig_PageSizeConfig) String() string
type DataMapping ¶
type DataMapping struct { Key string `protobuf:"bytes,1,opt,name=key,proto3" json:"key,omitempty"` Path *JsonPath `protobuf:"bytes,2,opt,name=path,proto3,oneof" json:"path,omitempty"` Object []*DataMapping `protobuf:"bytes,3,rep,name=object,proto3" json:"object,omitempty"` Value *ScalarValue `protobuf:"bytes,4,opt,name=value,proto3,oneof" json:"value,omitempty"` // contains filtered or unexported fields }
DataMapping maps a response value or a scalar value to inputs. For each input's key we can have one of: - a path to a response field - a dataMapping object (for nested fields) - a scalar value
func (*DataMapping) Descriptor
deprecated
func (*DataMapping) Descriptor() ([]byte, []int)
Deprecated: Use DataMapping.ProtoReflect.Descriptor instead.
func (*DataMapping) GetKey ¶
func (x *DataMapping) GetKey() string
func (*DataMapping) GetObject ¶
func (x *DataMapping) GetObject() []*DataMapping
func (*DataMapping) GetPath ¶
func (x *DataMapping) GetPath() *JsonPath
func (*DataMapping) GetValue ¶ added in v0.395.13
func (x *DataMapping) GetValue() *ScalarValue
func (*DataMapping) ProtoMessage ¶
func (*DataMapping) ProtoMessage()
func (*DataMapping) ProtoReflect ¶
func (x *DataMapping) ProtoReflect() protoreflect.Message
func (*DataMapping) Reset ¶
func (x *DataMapping) Reset()
func (*DataMapping) String ¶
func (x *DataMapping) String() string
type DisplayLayoutConfig ¶ added in v0.396.0
type DisplayLayoutConfig struct { // The type of the view: e.g. Inbox, Board, List, Calendar, Table, Data Grid Type DisplayLayoutConfig_Type `protobuf:"varint,1,opt,name=type,proto3,enum=tools.DisplayLayoutConfig_Type" json:"type,omitempty"` InboxConfig *InboxViewConfig `protobuf:"bytes,2,opt,name=inbox_config,json=inboxConfig,proto3,oneof" json:"inbox_config,omitempty"` BoardConfig *BoardViewConfig `protobuf:"bytes,3,opt,name=board_config,json=boardConfig,proto3,oneof" json:"board_config,omitempty"` GridConfig *GridViewConfig `protobuf:"bytes,4,opt,name=grid_config,json=gridConfig,proto3,oneof" json:"grid_config,omitempty"` // contains filtered or unexported fields }
func (*DisplayLayoutConfig) Descriptor
deprecated
added in
v0.396.0
func (*DisplayLayoutConfig) Descriptor() ([]byte, []int)
Deprecated: Use DisplayLayoutConfig.ProtoReflect.Descriptor instead.
func (*DisplayLayoutConfig) GetBoardConfig ¶ added in v0.397.3
func (x *DisplayLayoutConfig) GetBoardConfig() *BoardViewConfig
func (*DisplayLayoutConfig) GetGridConfig ¶ added in v0.398.0
func (x *DisplayLayoutConfig) GetGridConfig() *GridViewConfig
func (*DisplayLayoutConfig) GetInboxConfig ¶ added in v0.396.0
func (x *DisplayLayoutConfig) GetInboxConfig() *InboxViewConfig
func (*DisplayLayoutConfig) GetType ¶ added in v0.396.0
func (x *DisplayLayoutConfig) GetType() DisplayLayoutConfig_Type
func (*DisplayLayoutConfig) ProtoMessage ¶ added in v0.396.0
func (*DisplayLayoutConfig) ProtoMessage()
func (*DisplayLayoutConfig) ProtoReflect ¶ added in v0.396.0
func (x *DisplayLayoutConfig) ProtoReflect() protoreflect.Message
func (*DisplayLayoutConfig) Reset ¶ added in v0.396.0
func (x *DisplayLayoutConfig) Reset()
func (*DisplayLayoutConfig) String ¶ added in v0.396.0
func (x *DisplayLayoutConfig) String() string
type DisplayLayoutConfig_Type ¶ added in v0.396.0
type DisplayLayoutConfig_Type int32
const ( DisplayLayoutConfig_UNKNOWN DisplayLayoutConfig_Type = 0 DisplayLayoutConfig_INBOX DisplayLayoutConfig_Type = 1 DisplayLayoutConfig_BOARD DisplayLayoutConfig_Type = 2 DisplayLayoutConfig_GRID DisplayLayoutConfig_Type = 3 )
func (DisplayLayoutConfig_Type) Descriptor ¶ added in v0.396.0
func (DisplayLayoutConfig_Type) Descriptor() protoreflect.EnumDescriptor
func (DisplayLayoutConfig_Type) Enum ¶ added in v0.396.0
func (x DisplayLayoutConfig_Type) Enum() *DisplayLayoutConfig_Type
func (DisplayLayoutConfig_Type) EnumDescriptor
deprecated
added in
v0.396.0
func (DisplayLayoutConfig_Type) EnumDescriptor() ([]byte, []int)
Deprecated: Use DisplayLayoutConfig_Type.Descriptor instead.
func (DisplayLayoutConfig_Type) Number ¶ added in v0.396.0
func (x DisplayLayoutConfig_Type) Number() protoreflect.EnumNumber
func (DisplayLayoutConfig_Type) String ¶ added in v0.396.0
func (x DisplayLayoutConfig_Type) String() string
func (DisplayLayoutConfig_Type) Type ¶ added in v0.396.0
func (DisplayLayoutConfig_Type) Type() protoreflect.EnumType
type ExternalLink ¶
type ExternalLink struct { Label *StringTemplate `protobuf:"bytes,1,opt,name=label,proto3" json:"label,omitempty"` Href *StringTemplate `protobuf:"bytes,2,opt,name=href,proto3" json:"href,omitempty"` Icon *string `protobuf:"bytes,3,opt,name=icon,proto3,oneof" json:"icon,omitempty"` DisplayOrder int32 `protobuf:"varint,4,opt,name=display_order,json=displayOrder,proto3" json:"display_order,omitempty"` // contains filtered or unexported fields }
func (*ExternalLink) Descriptor
deprecated
func (*ExternalLink) Descriptor() ([]byte, []int)
Deprecated: Use ExternalLink.ProtoReflect.Descriptor instead.
func (*ExternalLink) GetDisplayOrder ¶ added in v0.395.13
func (x *ExternalLink) GetDisplayOrder() int32
func (*ExternalLink) GetHref ¶
func (x *ExternalLink) GetHref() *StringTemplate
func (*ExternalLink) GetIcon ¶
func (x *ExternalLink) GetIcon() string
func (*ExternalLink) GetLabel ¶
func (x *ExternalLink) GetLabel() *StringTemplate
func (*ExternalLink) ProtoMessage ¶
func (*ExternalLink) ProtoMessage()
func (*ExternalLink) ProtoReflect ¶
func (x *ExternalLink) ProtoReflect() protoreflect.Message
func (*ExternalLink) Reset ¶
func (x *ExternalLink) Reset()
func (*ExternalLink) String ¶
func (x *ExternalLink) String() string
type GridViewConfig ¶ added in v0.398.0
type GridViewConfig struct {
// contains filtered or unexported fields
}
A data-grid view, similar to a table view but providing rich editing and data manipulation features.
func (*GridViewConfig) Descriptor
deprecated
added in
v0.398.0
func (*GridViewConfig) Descriptor() ([]byte, []int)
Deprecated: Use GridViewConfig.ProtoReflect.Descriptor instead.
func (*GridViewConfig) ProtoMessage ¶ added in v0.398.0
func (*GridViewConfig) ProtoMessage()
func (*GridViewConfig) ProtoReflect ¶ added in v0.398.0
func (x *GridViewConfig) ProtoReflect() protoreflect.Message
func (*GridViewConfig) Reset ¶ added in v0.398.0
func (x *GridViewConfig) Reset()
func (*GridViewConfig) String ¶ added in v0.398.0
func (x *GridViewConfig) String() string
type InboxViewConfig ¶ added in v0.396.0
type InboxViewConfig struct { // A link to a get action that will be used when the item is expanded GetTool *ActionLink `protobuf:"bytes,1,opt,name=get_tool,json=getTool,proto3" json:"get_tool,omitempty"` // The primary content of the row Title *StringTemplate `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"` // The secondary content of the row Description *StringTemplate `protobuf:"bytes,3,opt,name=description,proto3,oneof" json:"description,omitempty"` // Content to be displayed in the right hand side of the row ContextField *StringTemplate `protobuf:"bytes,4,opt,name=context_field,json=contextField,proto3,oneof" json:"context_field,omitempty"` // If an avatar/image is to be displayed with every row AvatarEnabled bool `protobuf:"varint,5,opt,name=avatar_enabled,json=avatarEnabled,proto3" json:"avatar_enabled,omitempty"` // URL for the image. AvatarUrl *StringTemplate `protobuf:"bytes,6,opt,name=avatar_url,json=avatarUrl,proto3,oneof" json:"avatar_url,omitempty"` AvatarFallback *StringTemplate `protobuf:"bytes,7,opt,name=avatar_fallback,json=avatarFallback,proto3,oneof" json:"avatar_fallback,omitempty"` // contains filtered or unexported fields }
An email inbox style display for list views. Each item in a list will be displayed as a row with an exapandable view
func (*InboxViewConfig) Descriptor
deprecated
added in
v0.396.0
func (*InboxViewConfig) Descriptor() ([]byte, []int)
Deprecated: Use InboxViewConfig.ProtoReflect.Descriptor instead.
func (*InboxViewConfig) GetAvatarEnabled ¶ added in v0.396.0
func (x *InboxViewConfig) GetAvatarEnabled() bool
func (*InboxViewConfig) GetAvatarFallback ¶ added in v0.396.0
func (x *InboxViewConfig) GetAvatarFallback() *StringTemplate
func (*InboxViewConfig) GetAvatarUrl ¶ added in v0.396.0
func (x *InboxViewConfig) GetAvatarUrl() *StringTemplate
func (*InboxViewConfig) GetContextField ¶ added in v0.396.0
func (x *InboxViewConfig) GetContextField() *StringTemplate
func (*InboxViewConfig) GetDescription ¶ added in v0.396.0
func (x *InboxViewConfig) GetDescription() *StringTemplate
func (*InboxViewConfig) GetGetTool ¶ added in v0.396.0
func (x *InboxViewConfig) GetGetTool() *ActionLink
func (*InboxViewConfig) GetTitle ¶ added in v0.396.0
func (x *InboxViewConfig) GetTitle() *StringTemplate
func (*InboxViewConfig) ProtoMessage ¶ added in v0.396.0
func (*InboxViewConfig) ProtoMessage()
func (*InboxViewConfig) ProtoReflect ¶ added in v0.396.0
func (x *InboxViewConfig) ProtoReflect() protoreflect.Message
func (*InboxViewConfig) Reset ¶ added in v0.396.0
func (x *InboxViewConfig) Reset()
func (*InboxViewConfig) String ¶ added in v0.396.0
func (x *InboxViewConfig) String() string
type JsonPath ¶
type JsonPath struct { Path string `protobuf:"bytes,1,opt,name=path,proto3" json:"path,omitempty"` // contains filtered or unexported fields }
func (*JsonPath) Descriptor
deprecated
func (*JsonPath) ProtoMessage ¶
func (*JsonPath) ProtoMessage()
func (*JsonPath) ProtoReflect ¶
func (x *JsonPath) ProtoReflect() protoreflect.Message
type RequestFieldConfig ¶
type RequestFieldConfig struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // common fields FieldLocation *JsonPath `protobuf:"bytes,2,opt,name=field_location,json=fieldLocation,proto3" json:"field_location,omitempty"` FieldType proto.Type `protobuf:"varint,3,opt,name=field_type,json=fieldType,proto3,enum=proto.Type" json:"field_type,omitempty"` Repeated bool `protobuf:"varint,4,opt,name=repeated,proto3" json:"repeated,omitempty"` DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"` DisplayOrder int32 `protobuf:"varint,6,opt,name=display_order,json=displayOrder,proto3" json:"display_order,omitempty"` Visible bool `protobuf:"varint,7,opt,name=visible,proto3" json:"visible,omitempty"` HelpText *StringTemplate `protobuf:"bytes,8,opt,name=help_text,json=helpText,proto3,oneof" json:"help_text,omitempty"` // For a relation field - A list action with the fewest required inputs on the target model // Used to display a lookup/dropdown to allow selecting a entry for this field LookupAction *ActionLink `protobuf:"bytes,9,opt,name=lookup_action,json=lookupAction,proto3,oneof" json:"lookup_action,omitempty"` // For a relation field - Used for loading a preview GetEntryAction *ActionLink `protobuf:"bytes,10,opt,name=get_entry_action,json=getEntryAction,proto3,oneof" json:"get_entry_action,omitempty"` Locked bool `protobuf:"varint,11,opt,name=locked,proto3" json:"locked,omitempty"` DefaultValue *ScalarValue `protobuf:"bytes,12,opt,name=default_value,json=defaultValue,proto3,oneof" json:"default_value,omitempty"` Placeholder *StringTemplate `protobuf:"bytes,13,opt,name=placeholder,proto3,oneof" json:"placeholder,omitempty"` // If `type` is set to TYPE_ENUM then this value is the name of the // the enum that the type refers to. EnumName *string `protobuf:"bytes,14,opt,name=enum_name,json=enumName,proto3,oneof" json:"enum_name,omitempty"` // If this field is set then this type is referring to another model. // In the case of TYPE_MODEL this type _is_ the model named here. // In the case of other types e.g. TYPE_ID this type is referencing a field // on the model named here, and the specific field being referenced is indicated // by `field_name`. ModelName *string `protobuf:"bytes,15,opt,name=model_name,json=modelName,proto3,oneof" json:"model_name,omitempty"` // This field indicates which field on `model_name` this type is referencing. // This field should only be set if `model_name` is set. FieldName *string `protobuf:"bytes,16,opt,name=field_name,json=fieldName,proto3,oneof" json:"field_name,omitempty"` // The scope of the request(input) field. Not to be confused with field_type which gives us the data // type, this type tells us if the input controls pagination, filters or it's a generic input field Scope RequestFieldConfig_ScopeType `protobuf:"varint,17,opt,name=scope,proto3,enum=tools.RequestFieldConfig_ScopeType" json:"scope,omitempty"` // contains filtered or unexported fields }
func (*RequestFieldConfig) Descriptor
deprecated
func (*RequestFieldConfig) Descriptor() ([]byte, []int)
Deprecated: Use RequestFieldConfig.ProtoReflect.Descriptor instead.
func (*RequestFieldConfig) GetDefaultValue ¶
func (x *RequestFieldConfig) GetDefaultValue() *ScalarValue
func (*RequestFieldConfig) GetDisplayName ¶
func (x *RequestFieldConfig) GetDisplayName() string
func (*RequestFieldConfig) GetDisplayOrder ¶
func (x *RequestFieldConfig) GetDisplayOrder() int32
func (*RequestFieldConfig) GetEnumName ¶ added in v0.395.11
func (x *RequestFieldConfig) GetEnumName() string
func (*RequestFieldConfig) GetFieldLocation ¶
func (x *RequestFieldConfig) GetFieldLocation() *JsonPath
func (*RequestFieldConfig) GetFieldName ¶ added in v0.395.11
func (x *RequestFieldConfig) GetFieldName() string
func (*RequestFieldConfig) GetFieldType ¶
func (x *RequestFieldConfig) GetFieldType() proto.Type
func (*RequestFieldConfig) GetGetEntryAction ¶
func (x *RequestFieldConfig) GetGetEntryAction() *ActionLink
func (*RequestFieldConfig) GetHelpText ¶
func (x *RequestFieldConfig) GetHelpText() *StringTemplate
func (*RequestFieldConfig) GetId ¶
func (x *RequestFieldConfig) GetId() string
func (*RequestFieldConfig) GetLocked ¶
func (x *RequestFieldConfig) GetLocked() bool
func (*RequestFieldConfig) GetLookupAction ¶
func (x *RequestFieldConfig) GetLookupAction() *ActionLink
func (*RequestFieldConfig) GetModelName ¶ added in v0.395.11
func (x *RequestFieldConfig) GetModelName() string
func (*RequestFieldConfig) GetPlaceholder ¶
func (x *RequestFieldConfig) GetPlaceholder() *StringTemplate
func (*RequestFieldConfig) GetRepeated ¶ added in v0.395.9
func (x *RequestFieldConfig) GetRepeated() bool
func (*RequestFieldConfig) GetScope ¶ added in v0.396.7
func (x *RequestFieldConfig) GetScope() RequestFieldConfig_ScopeType
func (*RequestFieldConfig) GetVisible ¶
func (x *RequestFieldConfig) GetVisible() bool
func (*RequestFieldConfig) ProtoMessage ¶
func (*RequestFieldConfig) ProtoMessage()
func (*RequestFieldConfig) ProtoReflect ¶
func (x *RequestFieldConfig) ProtoReflect() protoreflect.Message
func (*RequestFieldConfig) Reset ¶
func (x *RequestFieldConfig) Reset()
func (*RequestFieldConfig) String ¶
func (x *RequestFieldConfig) String() string
type RequestFieldConfig_ScopeType ¶ added in v0.396.7
type RequestFieldConfig_ScopeType int32
const ( // Generic input fields RequestFieldConfig_DEFAULT RequestFieldConfig_ScopeType = 0 // Fields that control pagination RequestFieldConfig_PAGINATION RequestFieldConfig_ScopeType = 1 // Fields used to filter the results of a list action (e.g. where) RequestFieldConfig_FILTERS RequestFieldConfig_ScopeType = 2 // Inputs used to control sorting of results RequestFieldConfig_SORTING RequestFieldConfig_ScopeType = 3 )
func (RequestFieldConfig_ScopeType) Descriptor ¶ added in v0.396.7
func (RequestFieldConfig_ScopeType) Descriptor() protoreflect.EnumDescriptor
func (RequestFieldConfig_ScopeType) Enum ¶ added in v0.396.7
func (x RequestFieldConfig_ScopeType) Enum() *RequestFieldConfig_ScopeType
func (RequestFieldConfig_ScopeType) EnumDescriptor
deprecated
added in
v0.396.7
func (RequestFieldConfig_ScopeType) EnumDescriptor() ([]byte, []int)
Deprecated: Use RequestFieldConfig_ScopeType.Descriptor instead.
func (RequestFieldConfig_ScopeType) Number ¶ added in v0.396.7
func (x RequestFieldConfig_ScopeType) Number() protoreflect.EnumNumber
func (RequestFieldConfig_ScopeType) String ¶ added in v0.396.7
func (x RequestFieldConfig_ScopeType) String() string
func (RequestFieldConfig_ScopeType) Type ¶ added in v0.396.7
func (RequestFieldConfig_ScopeType) Type() protoreflect.EnumType
type ResponseFieldConfig ¶
type ResponseFieldConfig struct { Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` FieldLocation *JsonPath `protobuf:"bytes,2,opt,name=field_location,json=fieldLocation,proto3" json:"field_location,omitempty"` FieldType proto.Type `protobuf:"varint,3,opt,name=field_type,json=fieldType,proto3,enum=proto.Type" json:"field_type,omitempty"` Repeated bool `protobuf:"varint,4,opt,name=repeated,proto3" json:"repeated,omitempty"` // default to sentence case DisplayName string `protobuf:"bytes,5,opt,name=display_name,json=displayName,proto3" json:"display_name,omitempty"` DisplayOrder int32 `protobuf:"varint,6,opt,name=display_order,json=displayOrder,proto3" json:"display_order,omitempty"` Visible bool `protobuf:"varint,7,opt,name=visible,proto3" json:"visible,omitempty"` HelpText *StringTemplate `protobuf:"bytes,8,opt,name=help_text,json=helpText,proto3,oneof" json:"help_text,omitempty"` Sortable bool `protobuf:"varint,9,opt,name=sortable,proto3" json:"sortable,omitempty"` // Based on @sortable() // Set if this field is a FK and link to a get/list action on the target model // Or set to an appropriate list action if this field is a to-many field - for example, linking to listSaleItems(sale.id) Link *ActionLink `protobuf:"bytes,10,opt,name=link,proto3,oneof" json:"link,omitempty"` // for file fields only, display images inline ImagePreview bool `protobuf:"varint,11,opt,name=image_preview,json=imagePreview,proto3" json:"image_preview,omitempty"` // If `type` is set to TYPE_ENUM then this value is the name of the // the enum that the type refers to. EnumName *string `protobuf:"bytes,12,opt,name=enum_name,json=enumName,proto3,oneof" json:"enum_name,omitempty"` // If this field is set then this type is referring to another model. // In the case of TYPE_MODEL this type _is_ the model named here. // In the case of other types e.g. TYPE_ID this type is referencing a field // on the model named here, and the specific field being referenced is indicated // by `field_name`. ModelName *string `protobuf:"bytes,13,opt,name=model_name,json=modelName,proto3,oneof" json:"model_name,omitempty"` // This field indicates which field on `model_name` this type is referencing. // This field should only be set if `model_name` is set. FieldName *string `protobuf:"bytes,14,opt,name=field_name,json=fieldName,proto3,oneof" json:"field_name,omitempty"` // The scope of the response field. Not to be confused with field_type which gives us the data // type, this type tells us if the response is part of the pagination info or a generic api result // field Scope ResponseFieldConfig_ScopeType `protobuf:"varint,15,opt,name=scope,proto3,enum=tools.ResponseFieldConfig_ScopeType" json:"scope,omitempty"` // contains filtered or unexported fields }
func (*ResponseFieldConfig) Descriptor
deprecated
func (*ResponseFieldConfig) Descriptor() ([]byte, []int)
Deprecated: Use ResponseFieldConfig.ProtoReflect.Descriptor instead.
func (*ResponseFieldConfig) GetDisplayName ¶
func (x *ResponseFieldConfig) GetDisplayName() string
func (*ResponseFieldConfig) GetDisplayOrder ¶
func (x *ResponseFieldConfig) GetDisplayOrder() int32
func (*ResponseFieldConfig) GetEnumName ¶ added in v0.395.13
func (x *ResponseFieldConfig) GetEnumName() string
func (*ResponseFieldConfig) GetFieldLocation ¶
func (x *ResponseFieldConfig) GetFieldLocation() *JsonPath
func (*ResponseFieldConfig) GetFieldName ¶ added in v0.395.13
func (x *ResponseFieldConfig) GetFieldName() string
func (*ResponseFieldConfig) GetFieldType ¶
func (x *ResponseFieldConfig) GetFieldType() proto.Type
func (*ResponseFieldConfig) GetHelpText ¶
func (x *ResponseFieldConfig) GetHelpText() *StringTemplate
func (*ResponseFieldConfig) GetId ¶
func (x *ResponseFieldConfig) GetId() string
func (*ResponseFieldConfig) GetImagePreview ¶
func (x *ResponseFieldConfig) GetImagePreview() bool
func (*ResponseFieldConfig) GetLink ¶
func (x *ResponseFieldConfig) GetLink() *ActionLink
func (*ResponseFieldConfig) GetModelName ¶ added in v0.395.13
func (x *ResponseFieldConfig) GetModelName() string
func (*ResponseFieldConfig) GetRepeated ¶ added in v0.395.9
func (x *ResponseFieldConfig) GetRepeated() bool
func (*ResponseFieldConfig) GetScope ¶ added in v0.396.7
func (x *ResponseFieldConfig) GetScope() ResponseFieldConfig_ScopeType
func (*ResponseFieldConfig) GetSortable ¶
func (x *ResponseFieldConfig) GetSortable() bool
func (*ResponseFieldConfig) GetVisible ¶
func (x *ResponseFieldConfig) GetVisible() bool
func (*ResponseFieldConfig) ProtoMessage ¶
func (*ResponseFieldConfig) ProtoMessage()
func (*ResponseFieldConfig) ProtoReflect ¶
func (x *ResponseFieldConfig) ProtoReflect() protoreflect.Message
func (*ResponseFieldConfig) Reset ¶
func (x *ResponseFieldConfig) Reset()
func (*ResponseFieldConfig) String ¶
func (x *ResponseFieldConfig) String() string
type ResponseFieldConfig_ScopeType ¶ added in v0.396.7
type ResponseFieldConfig_ScopeType int32
const ( // Generic response fields (model fields, message fields) ResponseFieldConfig_DEFAULT ResponseFieldConfig_ScopeType = 0 // Fields giving pagination info (e.g. cursor, pageSize, etc) ResponseFieldConfig_PAGINATION ResponseFieldConfig_ScopeType = 1 )
func (ResponseFieldConfig_ScopeType) Descriptor ¶ added in v0.396.7
func (ResponseFieldConfig_ScopeType) Descriptor() protoreflect.EnumDescriptor
func (ResponseFieldConfig_ScopeType) Enum ¶ added in v0.396.7
func (x ResponseFieldConfig_ScopeType) Enum() *ResponseFieldConfig_ScopeType
func (ResponseFieldConfig_ScopeType) EnumDescriptor
deprecated
added in
v0.396.7
func (ResponseFieldConfig_ScopeType) EnumDescriptor() ([]byte, []int)
Deprecated: Use ResponseFieldConfig_ScopeType.Descriptor instead.
func (ResponseFieldConfig_ScopeType) Number ¶ added in v0.396.7
func (x ResponseFieldConfig_ScopeType) Number() protoreflect.EnumNumber
func (ResponseFieldConfig_ScopeType) String ¶ added in v0.396.7
func (x ResponseFieldConfig_ScopeType) String() string
func (ResponseFieldConfig_ScopeType) Type ¶ added in v0.396.7
func (ResponseFieldConfig_ScopeType) Type() protoreflect.EnumType
type ResponseOverrides ¶ added in v0.395.13
type ResponseOverrides struct { FieldLocation *JsonPath `protobuf:"bytes,1,opt,name=field_location,json=fieldLocation,proto3" json:"field_location,omitempty"` // Controls the visibility of the response field Visible bool `protobuf:"varint,2,opt,name=visible,proto3" json:"visible,omitempty"` // contains filtered or unexported fields }
func (*ResponseOverrides) Descriptor
deprecated
added in
v0.395.13
func (*ResponseOverrides) Descriptor() ([]byte, []int)
Deprecated: Use ResponseOverrides.ProtoReflect.Descriptor instead.
func (*ResponseOverrides) GetFieldLocation ¶ added in v0.395.13
func (x *ResponseOverrides) GetFieldLocation() *JsonPath
func (*ResponseOverrides) GetVisible ¶ added in v0.395.13
func (x *ResponseOverrides) GetVisible() bool
func (*ResponseOverrides) ProtoMessage ¶ added in v0.395.13
func (*ResponseOverrides) ProtoMessage()
func (*ResponseOverrides) ProtoReflect ¶ added in v0.395.13
func (x *ResponseOverrides) ProtoReflect() protoreflect.Message
func (*ResponseOverrides) Reset ¶ added in v0.395.13
func (x *ResponseOverrides) Reset()
func (*ResponseOverrides) String ¶ added in v0.395.13
func (x *ResponseOverrides) String() string
type ScalarValue ¶ added in v0.395.13
type ScalarValue struct { // Types that are assignable to Value: // // *ScalarValue_String_ // *ScalarValue_Integer // *ScalarValue_Float // *ScalarValue_Bool // *ScalarValue_Null Value isScalarValue_Value `protobuf_oneof:"value"` // contains filtered or unexported fields }
func (*ScalarValue) Descriptor
deprecated
added in
v0.395.13
func (*ScalarValue) Descriptor() ([]byte, []int)
Deprecated: Use ScalarValue.ProtoReflect.Descriptor instead.
func (*ScalarValue) GetBool ¶ added in v0.395.13
func (x *ScalarValue) GetBool() bool
func (*ScalarValue) GetFloat ¶ added in v0.395.13
func (x *ScalarValue) GetFloat() float32
func (*ScalarValue) GetInteger ¶ added in v0.395.13
func (x *ScalarValue) GetInteger() int32
func (*ScalarValue) GetNull ¶ added in v0.396.7
func (x *ScalarValue) GetNull() bool
func (*ScalarValue) GetString_ ¶ added in v0.395.13
func (x *ScalarValue) GetString_() string
func (*ScalarValue) GetValue ¶ added in v0.395.13
func (m *ScalarValue) GetValue() isScalarValue_Value
func (*ScalarValue) ProtoMessage ¶ added in v0.395.13
func (*ScalarValue) ProtoMessage()
func (*ScalarValue) ProtoReflect ¶ added in v0.395.13
func (x *ScalarValue) ProtoReflect() protoreflect.Message
func (*ScalarValue) Reset ¶ added in v0.395.13
func (x *ScalarValue) Reset()
func (*ScalarValue) String ¶ added in v0.395.13
func (x *ScalarValue) String() string
type ScalarValue_Bool ¶ added in v0.395.13
type ScalarValue_Bool struct {
Bool bool `protobuf:"varint,4,opt,name=bool,proto3,oneof"`
}
type ScalarValue_Float ¶ added in v0.395.13
type ScalarValue_Float struct {
Float float32 `protobuf:"fixed32,3,opt,name=float,proto3,oneof"`
}
type ScalarValue_Integer ¶ added in v0.395.13
type ScalarValue_Integer struct {
Integer int32 `protobuf:"varint,2,opt,name=integer,proto3,oneof"`
}
type ScalarValue_Null ¶ added in v0.396.7
type ScalarValue_Null struct { // This indicates that the value is NULL Null bool `protobuf:"varint,5,opt,name=null,proto3,oneof"` }
type ScalarValue_String_ ¶ added in v0.395.13
type ScalarValue_String_ struct {
String_ string `protobuf:"bytes,1,opt,name=string,proto3,oneof"`
}
type StringTemplate ¶
type StringTemplate struct { // e.g. "{{$.firstName}} {{$.lastName}}" template syntax TBC. Template string `protobuf:"bytes,1,opt,name=template,proto3" json:"template,omitempty"` // If markdown is supported for this template. e.g. // Italic text: _{{$.Var}}_ Markdown bool `protobuf:"varint,2,opt,name=markdown,proto3" json:"markdown,omitempty"` // contains filtered or unexported fields }
func (*StringTemplate) Descriptor
deprecated
func (*StringTemplate) Descriptor() ([]byte, []int)
Deprecated: Use StringTemplate.ProtoReflect.Descriptor instead.
func (*StringTemplate) GetMarkdown ¶
func (x *StringTemplate) GetMarkdown() bool
func (*StringTemplate) GetTemplate ¶
func (x *StringTemplate) GetTemplate() string
func (*StringTemplate) ProtoMessage ¶
func (*StringTemplate) ProtoMessage()
func (*StringTemplate) ProtoReflect ¶
func (x *StringTemplate) ProtoReflect() protoreflect.Message
func (*StringTemplate) Reset ¶
func (x *StringTemplate) Reset()
func (*StringTemplate) String ¶
func (x *StringTemplate) String() string
type ToolGroup ¶ added in v0.395.14
type ToolGroup struct { // A reference that persists for this tool group from build to build Id string `protobuf:"bytes,1,opt,name=id,proto3" json:"id,omitempty"` // Title of the group Title *StringTemplate `protobuf:"bytes,2,opt,name=title,proto3" json:"title,omitempty"` DisplayOrder int32 `protobuf:"varint,3,opt,name=display_order,json=displayOrder,proto3" json:"display_order,omitempty"` // A list of decorated ActionLinks which will be embedded within this group Tools []*ToolGroup_GroupActionLink `protobuf:"bytes,4,rep,name=tools,proto3" json:"tools,omitempty"` Visible bool `protobuf:"varint,5,opt,name=visible,proto3" json:"visible,omitempty"` // contains filtered or unexported fields }
func (*ToolGroup) Descriptor
deprecated
added in
v0.395.14
func (*ToolGroup) GetDisplayOrder ¶ added in v0.395.14
func (*ToolGroup) GetTitle ¶ added in v0.395.14
func (x *ToolGroup) GetTitle() *StringTemplate
func (*ToolGroup) GetTools ¶ added in v0.395.14
func (x *ToolGroup) GetTools() []*ToolGroup_GroupActionLink
func (*ToolGroup) GetVisible ¶ added in v0.396.7
func (*ToolGroup) ProtoMessage ¶ added in v0.395.14
func (*ToolGroup) ProtoMessage()
func (*ToolGroup) ProtoReflect ¶ added in v0.395.14
func (x *ToolGroup) ProtoReflect() protoreflect.Message
type ToolGroup_GroupActionLink ¶ added in v0.395.14
type ToolGroup_GroupActionLink struct { ActionLink *ActionLink `protobuf:"bytes,1,opt,name=action_link,json=actionLink,proto3" json:"action_link,omitempty"` // The config for responses of the target tool for this embedded action can be altered for // this embed group ResponseOverrides []*ResponseOverrides `protobuf:"bytes,2,rep,name=response_overrides,json=responseOverrides,proto3" json:"response_overrides,omitempty"` // contains filtered or unexported fields }
When embedding ActionLinks, we need to provide extra-configuration that will override the link's target tool configuration
func (*ToolGroup_GroupActionLink) Descriptor
deprecated
added in
v0.395.14
func (*ToolGroup_GroupActionLink) Descriptor() ([]byte, []int)
Deprecated: Use ToolGroup_GroupActionLink.ProtoReflect.Descriptor instead.
func (*ToolGroup_GroupActionLink) GetActionLink ¶ added in v0.395.14
func (x *ToolGroup_GroupActionLink) GetActionLink() *ActionLink
func (*ToolGroup_GroupActionLink) GetResponseOverrides ¶ added in v0.395.14
func (x *ToolGroup_GroupActionLink) GetResponseOverrides() []*ResponseOverrides
func (*ToolGroup_GroupActionLink) ProtoMessage ¶ added in v0.395.14
func (*ToolGroup_GroupActionLink) ProtoMessage()
func (*ToolGroup_GroupActionLink) ProtoReflect ¶ added in v0.395.14
func (x *ToolGroup_GroupActionLink) ProtoReflect() protoreflect.Message
func (*ToolGroup_GroupActionLink) Reset ¶ added in v0.395.14
func (x *ToolGroup_GroupActionLink) Reset()
func (*ToolGroup_GroupActionLink) String ¶ added in v0.395.14
func (x *ToolGroup_GroupActionLink) String() string