package proto

Get desktop application:
View/edit binary Protocol Buffers messages

Used in: Model

• string model_name = 1

  The name of the model this action belongs to.

• string name = 2

  The name of the action. Must be in lowerCamelCase and be unique across all actions across all models within the schema. This is because in both RPC and GraphQL actions are top-level and so two different models can't both define an actions with the same name.

• ActionType type = 3

  The type of this action.

• ActionImplementation implementation = 4

  Whether this action will be auto-generated by Keel or implemented with a function.

• repeated PermissionRule permissions = 6

  A list of permission rules to apply to this action

• repeated Expression set_expressions = 7

  A list of assignment expression to be executed as part of this action. Only valid in `type` is ACTION_TYPE_CREATE or ACTION_TYPE_UPDATE

• repeated Expression where_expressions = 8

  A list of logical expressions to be applied to the database query being executed as part of the action. Not valid if `type` is ACTION_TYPE_CREATE If there are multiple entries in this field they are AND'd.

• repeated Expression validation_expressions = 9

  A list of expressions that perform some kind of validation (likely on the inputs).

• repeated OrderByStatement order_by = 10

  A ordered list of order by statements.

• string input_message_name = 11

  The name of the input message type for this action.

• string response_message_name = 12

  The name of the response message type for this action when not a built-in action. This is because built-in action responses are determined by the action type (get, list, create, update, delete).

• repeated string response_embeds = 13

  Embedded data can be attached to the response message of built in actions (get, list).

• repeated string facets = 14

  Field names to facet on as defined with @facet in the schema.

Describes where and by which party the implementation for an action is provided.

Used in: Action, tools.ActionConfig

• ACTION_IMPLEMENTATION_UNKNOWN = 0

• ACTION_IMPLEMENTATION_AUTO = 1

  Auto means the implementation of the action is generated by Keel based on the specified action type (get, create, update, list, delete)

• ACTION_IMPLEMENTATION_CUSTOM = 2

  Custom means the implementation of the action is provided via custom functions code. The code itself is not represented in this proto schema.

• ACTION_IMPLEMENTATION_RUNTIME = 3

  Runtime means the implementation of the action is provided in the runtime code.

Describes the behaviour of an action and a preordained input and output specification.

Used in: Action, Event, PermissionRule, tools.ActionConfig

• ACTION_TYPE_UNKNOWN = 0

• ACTION_TYPE_CREATE = 1

  Creates a new record and returns it.

• ACTION_TYPE_GET = 2

  Returns a single record by looking up on a unique field.

• ACTION_TYPE_LIST = 3

  Lists records optionally filtering on certain fields. The response would be a an object that supports pagination functionality and contains a "page" of results.

• ACTION_TYPE_UPDATE = 4

  Update a single record by providing a unique lookup and some fields to update. The resulting record is returned.

• ACTION_TYPE_DELETE = 5

  Delete a record and returns it's ID.

• ACTION_TYPE_READ = 6

  A generic read action.

• ACTION_TYPE_WRITE = 7

  A generic write action.

Used in: Schema

• string name = 1

• repeated ApiModel api_models = 3

Used in: Api

• string model_name = 1

• repeated ApiModelAction model_actions = 2

Used in: ApiModel

• string action_name = 1

Used in: Field

• bool use_zero_value = 1

  If true then a "zero" value is used for the field, for example a string has a zero value of "" and a date has a zero value of today

• optional Expression expression = 2

  This can be used to explicitly set the default value

Used in: Schema

• string name = 1

• repeated EnumValue values = 2

Used in: Enum

• string name = 1

Used in: Schema

• string name = 1

• bool required = 2

Events that can be triggered based on what has been defined in the schema. At the moment, we only support model-level events for create, update and delete mutations. This can be extended to support other kinds of events.

Used in: Schema

• string name = 1

  The name of this event, for example: account.created

• string model_name = 2

  The name of the model.

• ActionType action_type = 3

  Action type (create, update or delete).

Used in: Action, DefaultValue, Field, PermissionRule

• string source = 1

Used in: Model

• string model_name = 1

  The name of the model this field belongs to.

• string name = 2

  The name of the field. Must be in lowerCamelCase and be unique within the model.

• optional TypeInfo type = 3

  Info regarding the type of this field

• bool optional = 4

  If true then this field is allowed to be null

• bool unique = 5

  If true then this field will have a unique constraint added to it meaning a given value can only exist in a single row. Cannot be true if `type.repeated` is true

• repeated string unique_with = 8

  If set then this field is part of a compount unique constraint with the fields listed. The fields must be part of the same model and they must list this field in their unique_with value.

• bool primary_key = 7

  If true then this field will be set as the primary key for the parent model

• optional google.protobuf.StringValue foreign_key_field_name = 10

  If this field is of type TYPE_MODEL then this field indicates which field on _this_ model is the foriegn key. This field should always be populated on the many side of a one-to-many relationship and on the unique side of a one-to-one.

• optional DefaultValue default_value = 9

  This describes how the default value of this field should be created

• optional ForeignKeyInfo foreign_key_info = 11

  This only applies to the foreign key fields that we auto inject. If it is non null it *defines* this field as being a foreign key field, and carries corresponding metadata.

• optional google.protobuf.StringValue inverse_field_name = 12

  If this field is of type MODEL and the related model has an inverse field to this one, then this field is set to that field name. For example if a Post model has a field called author which is of type Author, and then Author has posts which is of type Post, on the Post.author field this value will be "posts" and on the Author.posts field this value will be "author".

• optional Expression computed_expression = 13

  If computed then this field will contain the expression that will be evaluated to determine the value of the field at runtime.

• optional Sequence sequence = 14

  If this field is a sequence this contains information about how the sequence value should be generated

Used in: Schema

• string name = 1

  The name of the workflow.

• string input_message_name = 2

  The inputs defined on the workflow.

• repeated PermissionRule permissions = 3

  A permission rule which need to be satisfied in order to run the flow.

Used in: Field

• string related_model_name = 1

• string related_model_field = 2

Used in: Route

• HTTP_METHOD_UNKNOWN = 0

• HTTP_METHOD_GET = 1

• HTTP_METHOD_POST = 2

• HTTP_METHOD_PUT = 3

• HTTP_METHOD_DELETE = 4

Used in: Schema

• string name = 1

  The name of the job.

• string input_message_name = 2

  The inputs defined on the job.

• repeated PermissionRule permissions = 3

  A permission rule which need to be satisfied in order to run the job.

• optional Schedule schedule = 4

  The schedule as an crontab expression.

Used in: Schema

• string name = 1

  Name of the input or response message. Either generated from built-in actions, hard-coded into the runtime (e.g. AuthenticateResponseMessage), or specified in the schema using the message keyword.

• repeated MessageField fields = 2

  The input or response fields for this message.

• optional TypeInfo type = 3

  The message could be a Keel type and not an object. Cannot be provided along with fields.

Used in: Message

• string message_name = 1

  Name of the parent message.

• string name = 2

  Name of the field.

• optional TypeInfo type = 3

  The type of this field.

• bool optional = 4

  Set to true if this can be omitted.

• bool nullable = 6

  Set to true if this can be set to the null value.

• repeated string target = 5

  Only valid for implicit inputs on built-in actions (ACTION_IMPLEMENTATION_AUTO) This field can be set to a path, from the current model, to a field that should be read from or written to automatically by the runtime. As an example if the parent model had a field called `item` which was a relationship to an `Item` model which itself had a field called `price`, and this input wanted to filter on the item price, then the value of `target` would be ["item", "price"].

Used in: Schema

• string name = 1

  The name of the model. Must be in PascalCase and be unique within the schema.

• repeated Field fields = 2

  The fields this model contains

• repeated Action actions = 3

  The actions this model defines. Contains both actions that will be auto generated and also functions

• repeated PermissionRule permissions = 4

Used in: Action

• string field_name = 1

  The name of the field to perform ordering on.

• OrderDirection direction = 2

  The direction in which to order.

Used in: OrderByStatement

• ORDER_DIRECTION_UNKNOWN = 0

• ORDER_DIRECTION_ASCENDING = 1

• ORDER_DIRECTION_DECENDING = 2

Used in: Action, Flow, Job, Model

• string model_name = 1

  Name of the model this permission rule applies to

• optional google.protobuf.StringValue action_name = 2

  Name of the specific action this permission rule applies to. If this field is populated then `action_types` is ignored.

• repeated string role_names = 3

  A name of a Role that has been defined in the schema. Cannot be provided if `expression` is provided.

• optional Expression expression = 4

  An expression to evaluate at runtime. Cannot be provided if `role_name` is provided.

• repeated ActionType action_types = 5

  A list of action types that this permission rule applies to Should not be set if `action_name` is provided.

Used in: Schema

• string name = 1

  The name of the role

• repeated string domains = 2

  A list of domains to match for this role e.g. myorg.com

• repeated string emails = 3

  A list of specific email addresses to match for this role eg. sarah@myorg.com

Used in: Schema

• HttpMethod method = 1

• string pattern = 2

• string handler = 3

Used in: Job

• string expression = 1

Used in: rpc.GetSchemaResponse

• repeated Model models = 1

• repeated Role roles = 2

• repeated Api apis = 3

• repeated Enum enums = 4

• repeated EnvironmentVariable environment_variables = 5

• repeated Message messages = 6

• repeated Secret secrets = 7

• repeated Job jobs = 8

• repeated Subscriber subscribers = 9

• repeated Event events = 10

• repeated Route routes = 11

• repeated Flow flows = 12

Used in: Schema

• string name = 1

• bool required = 2

Used in: Field

• string prefix = 1

• uint32 starts_at = 2

Used in: Schema

• string name = 1

  The name of the subscriber function. e.g. sendWelcomeMail.

• string input_message_name = 2

  The input message for this function. The structure of this is determined by the events handled by this subscriber.

• repeated string event_names = 3

  The events which are handled by this subscriber.

Used in: TypeInfo, tools.RequestFieldConfig, tools.ResponseFieldConfig

• TYPE_UNKNOWN = 0

• TYPE_STRING = 1

• TYPE_BOOL = 2

• TYPE_INT = 3

• TYPE_TIMESTAMP = 4

• TYPE_DATE = 5

• TYPE_ID = 6

• TYPE_MODEL = 7

• TYPE_CURRENCY = 8

• TYPE_DATETIME = 9

• TYPE_ENUM = 10

• TYPE_IMAGE = 12

• TYPE_OBJECT = 13

• TYPE_SECRET = 14

  Used for sensitive data. Encrypted at rest, decrypted on read.

• TYPE_PASSWORD = 15

  Used for hashing passwords and passcodes with the intention to verify admission.

• TYPE_MESSAGE = 16

• TYPE_ANY = 17

  Any is used in Message types to denote a field with any type.

• TYPE_SORT_DIRECTION = 18

  Used to specify a sort direction argument.

• TYPE_UNION = 19

  A union type describes a value that can be one of several types. These types are listed in TypeInfo's Union_Names property.

• TYPE_STRING_LITERAL = 20

  A string literal type which can be used to discriminate on in our Typescript types. TYPE_INFO string_literal_type must also be set.

• TYPE_MARKDOWN = 21

  Markdown rich text field.

• TYPE_DECIMAL = 22

  Decimal number type; fixed precision.

• TYPE_VECTOR = 23

  A vector type.

• TYPE_FILE = 24

  A file storage type.

• TYPE_RELATIVE_PERIOD = 25

  A relative period expression string; e.g. `today/next year`

• TYPE_DURATION = 26

  A time duration

Used in: Field, Message, MessageField

• Type type = 1

  The type of the field.

• optional google.protobuf.StringValue enum_name = 2

  If `type` is set to TYPE_ENUM then this value is the name of the the enum that the type refers to.

• optional google.protobuf.StringValue model_name = 3

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

• optional google.protobuf.StringValue field_name = 5

  This field indicates which field on `model_name` this type is referencing. This field should only be set if `model_name` is set.

• optional google.protobuf.StringValue message_name = 6

  Only valid within a Message

• bool repeated = 4

  If true then is type is an array of it's `type`

• repeated google.protobuf.StringValue union_names = 7

  A union type describes a value that can be one of several types. When TypeInfo's type property is set to UNION, then any one of the type names listed here can be used as input. Currently only support messages.

• optional google.protobuf.StringValue string_literal_value = 8

  For types which are in a union, it is optional to provide a value to discriminate on. This is only useful in TypeScript type generation, where this will make type a string literal type.