package api.v1.project.settings

Get desktop application:
View/edit binary Protocol Buffers messages

Service for setting and retrieving project-wide settings.

• rpc GetSettings (GetSettingsRequest, GetSettingsResponse)

  service.proto:12

  Gets the users settings for the current project.

  message GetSettingsRequest

  service.proto:31

  Empty get settings request

  (message has no fields)

  message GetSettingsResponse

  service.proto:34

  Response for getting settings for the project.

  • optional Settings settings = 1

    The settings.

• rpc UpdateSettings (UpdateSettingsRequest, UpdateSettingsResponse)

  service.proto:14

  Sets the users settings for the current project.

  message UpdateSettingsRequest

  service.proto:40

  Request for updating settings for a project.

  • repeated Update updates = 1

    The updates to apply.

  message UpdateSettingsResponse

  service.proto:46

  Empty response for updating a project's settings.

  (message has no fields)

• rpc GetLicenseInfo (GetLicenseInfoRequest, GetLicenseInfoResponse)

  service.proto:16

  Get License Information.

  message GetLicenseInfoRequest

  service.proto:20

  Request to get the license information of the Rig installation.

  (message has no fields)

  message GetLicenseInfoResponse

  service.proto:23

  Response for getting the license information of the Rig installation.

  // The plan of the rig installation. api.v1.project.Plan plan = 1; // The expiration date of the license. google.protobuf.Timestamp expires_at = 2;

  (message has no fields)

Message for adding a docker registry

Used in: Update

• string host = 1

  The host of the docker registry.

• oneof field

  • string auth = 2

    authentication string to the docker registry.

  • DockerRegistryCredentials credentials = 3

    Credentials for the docker registry.

Docker registry.

Used in: Settings

• string secret_id = 1

  The secret id of the docker registry.

• string host = 2

  Host of the docker registry/

Credentials for a docker registry.

Used in: AddDockerRegistry

• string username = 1

  Username for the docker registry.

• string password = 2

  Password for the docker registry.

• string email = 3

  Email for the docker registry.

Project wide settings.

Used in: GetSettingsResponse

• repeated DockerRegistry docker_registries = 4

  Docker registries for images.

Update message for project settings.

Used in: UpdateSettingsRequest

• oneof field

  A number of updates to apply to the project settings.

  • AddDockerRegistry add_docker_registry = 4

    Add a docker registry.

  • string delete_docker_registry = 5

    Delete a docker registry.