proto

package
v0.395.10 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 2, 2024 License: AGPL-3.0 Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
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"`
	// Only for 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.
	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"`
	// Tools that will be displayed inline (embedded) withing the one that we're defining.
	EmbeddedActions []*ActionLink `protobuf:"bytes,20,rep,name=embedded_actions,json=embeddedActions,proto3" json:"embedded_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"`
	// 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) GetEmbeddedActions 

func (x *ActionConfig) GetEmbeddedActions() []*ActionLink

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 (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 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 *StringTemplate `protobuf:"bytes,4,opt,name=title,proto3,oneof" json:"title,omitempty"` // Empty by default
	// contains filtered or unexported fields
}

func (*ActionLink) Descriptor deprecated 

func (*ActionLink) Descriptor() ([]byte, []int)

Deprecated: Use ActionLink.ProtoReflect.Descriptor instead.

func (*ActionLink) GetData 

func (x *ActionLink) GetData() []*DataMapping

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 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"`
	// contains filtered or unexported fields
}

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) 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 DefaultValue 

type DefaultValue struct {

	// Types that are assignable to Value:
	//
	//	*DefaultValue_String_
	//	*DefaultValue_Integer
	//	*DefaultValue_Float
	//	*DefaultValue_Bool
	Value isDefaultValue_Value `protobuf_oneof:"value"`
	// contains filtered or unexported fields
}

func (*DefaultValue) Descriptor deprecated 

func (*DefaultValue) Descriptor() ([]byte, []int)

Deprecated: Use DefaultValue.ProtoReflect.Descriptor instead.

func (*DefaultValue) GetBool 

func (x *DefaultValue) GetBool() bool

func (*DefaultValue) GetFloat 

func (x *DefaultValue) GetFloat() float32

func (*DefaultValue) GetInteger 

func (x *DefaultValue) GetInteger() int32

func (*DefaultValue) GetString_ 

func (x *DefaultValue) GetString_() string

func (*DefaultValue) GetValue 

func (m *DefaultValue) GetValue() isDefaultValue_Value

func (*DefaultValue) ProtoMessage 

func (*DefaultValue) ProtoMessage()

func (*DefaultValue) ProtoReflect 

func (x *DefaultValue) ProtoReflect() protoreflect.Message

func (*DefaultValue) Reset 

func (x *DefaultValue) Reset()

func (*DefaultValue) String 

func (x *DefaultValue) String() string

type DefaultValue_Bool 

type DefaultValue_Bool struct {
	Bool bool `protobuf:"varint,4,opt,name=bool,proto3,oneof"`
}

type DefaultValue_Float 

type DefaultValue_Float struct {
	Float float32 `protobuf:"fixed32,3,opt,name=float,proto3,oneof"`
}

type DefaultValue_Integer 

type DefaultValue_Integer struct {
	Integer int32 `protobuf:"varint,2,opt,name=integer,proto3,oneof"`
}

type DefaultValue_String_ 

type DefaultValue_String_ struct {
	String_ string `protobuf:"bytes,1,opt,name=string,proto3,oneof"`
}
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"`
	// contains filtered or unexported fields
}

func (*ExternalLink) Descriptor deprecated 

func (*ExternalLink) Descriptor() ([]byte, []int)

Deprecated: Use ExternalLink.ProtoReflect.Descriptor instead.

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 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) Descriptor() ([]byte, []int)

Deprecated: Use JsonPath.ProtoReflect.Descriptor instead.

func (*JsonPath) GetPath 

func (x *JsonPath) GetPath() string

func (*JsonPath) ProtoMessage 

func (*JsonPath) ProtoMessage()

func (*JsonPath) ProtoReflect 

func (x *JsonPath) ProtoReflect() protoreflect.Message

func (*JsonPath) Reset 

func (x *JsonPath) Reset()

func (*JsonPath) String 

func (x *JsonPath) String() string

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   *DefaultValue   `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"`
	// 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() *DefaultValue

func (*RequestFieldConfig) GetDisplayName 

func (x *RequestFieldConfig) GetDisplayName() string

func (*RequestFieldConfig) GetDisplayOrder 

func (x *RequestFieldConfig) GetDisplayOrder() int32

func (*RequestFieldConfig) GetFieldLocation 

func (x *RequestFieldConfig) GetFieldLocation() *JsonPath

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) GetPlaceholder 

func (x *RequestFieldConfig) GetPlaceholder() *StringTemplate

func (*RequestFieldConfig) GetRepeated added in v0.395.9 

func (x *RequestFieldConfig) GetRepeated() bool

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 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"`
	// 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) GetFieldLocation 

func (x *ResponseFieldConfig) GetFieldLocation() *JsonPath

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 (x *ResponseFieldConfig) GetLink() *ActionLink

func (*ResponseFieldConfig) GetRepeated added in v0.395.9 

func (x *ResponseFieldConfig) GetRepeated() bool

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 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

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.