package api.v1.settings

Get desktop application:
View/edit binary Protocol Buffers messages

Service for setting and retrieving platform-wide settings.

• rpc GetConfiguration (GetConfigurationRequest, GetConfigurationResponse)

  service.proto:13

  message GetConfigurationRequest

  service.proto:47

  (message has no fields)

  message GetConfigurationResponse

  service.proto:49

  • optional Configuration configuration = 1

• rpc GetSettings (GetSettingsRequest, GetSettingsResponse)

  service.proto:16

  message GetSettingsRequest

  service.proto:35

  (message has no fields)

  message GetSettingsResponse

  service.proto:37

  • optional Settings settings = 1

• rpc UpdateSettings (UpdateSettingsRequest, UpdateSettingsResponse)

  service.proto:17

  message UpdateSettingsRequest

  service.proto:41

  • repeated Update updates = 1

  message UpdateSettingsResponse

  service.proto:45

  (message has no fields)

• rpc GetLicenseInfo (GetLicenseInfoRequest, GetLicenseInfoResponse)

  service.proto:19

  message GetLicenseInfoRequest

  service.proto:25

  Request to get the license information of the Rig installation.

  (message has no fields)

  message GetLicenseInfoResponse

  service.proto:28

  Response for getting the license information of the Rig installation.

  • optional google.protobuf.Timestamp expires_at = 2

    The expiration date of the license.

  • int32 user_limit = 3

    The number of users allowed in the installation.

• rpc GetGitStoreStatus (GetGitStoreStatusRequest, GetGitStoreStatusResponse)

  service.proto:20

  message GetGitStoreStatusRequest

  service.proto:53

  (message has no fields)

  message GetGitStoreStatusResponse

  service.proto:55

  • repeated GetGitStoreStatusResponse.RepoGitStatus repositories = 1

  • repeated GetGitStoreStatusResponse.CapsuleStatus capsules = 2

  • repeated GetGitStoreStatusResponse.CapsuleSetStatus capsule_sets = 4

  • repeated GetGitStoreStatusResponse.CallbackErr errors = 3

Used in: Configuration

• optional Slack slack = 1

• repeated EmailClient email = 2

• repeated Git git = 3

Platform wide static configuration.

Used in: GetConfigurationResponse

• optional Client client = 1

• repeated string docker_registries = 2

• optional EmailClient default_email = 3

• map<string, Extension> capsule_extensions = 4

Used in: Client, Configuration

• string id = 1

• EmailType type = 2

Used in: EmailClient

• EMAIL_TYPE_UNSPECIFIED = 0

• EMAIL_TYPE_MAILJET = 1

• EMAIL_TYPE_SMTP = 2

Used in: Configuration

• string json_schema = 1

  The schema of the extension, expressed as a json-schema (https://json-schema.org/).

Used in: GetGitStoreStatusResponse

• string err = 1

• optional google.protobuf.Timestamp timestamp = 2

Used in: GetGitStoreStatusResponse

• optional model.CapsuleSetID capsule = 1

• optional model.GitStatus status = 2

Used in: GetGitStoreStatusResponse

• optional model.CapsuleID capsule = 1

• optional model.GitStatus status = 3

Used in: GetGitStoreStatusResponse

• optional model.RepoBranch repo = 1

• optional model.GitStatus status = 2

Used in: Client

• string url = 1

  URL is a exact match for the repo-url this auth can be used for.

• string url_prefix = 2

  URLPrefix is a prefix-match for the repo urls this auth can be used for.

The plan for a rig installation

• PLAN_UNSPECIFIED = 0

  Unspecified / unactivated plan.

• PLAN_FREE = 1

  Free tier.

• PLAN_TEAM = 2

  Team / Pro tier.

• PLAN_ENTERPRISE = 3

  Enterprise tier.

Platform wide settings.

Used in: GetSettingsResponse

• repeated model.NotificationNotifier notification_notifiers = 1

• optional model.GitStore git_store = 2

• repeated model.Pipeline pipelines = 3

Used in: Client

• repeated Slack.Workspace workspace = 1

Used in: Slack

• string name = 1

Update message for platform settings.

Used in: UpdateSettingsRequest

• oneof field

  • Update.SetNotificationNotifiers set_notification_notifiers = 1

    Set the notification notifiers.

  • model.GitStore set_git_store = 2

    Set the git store.

  • Update.SetPipelines set_pipelines = 3

    Set the pipelines.

Used in: Update

• repeated model.NotificationNotifier notifiers = 1

Used in: Update

• repeated model.Pipeline pipelines = 1