Workspaces

message RegisterWorkspaceRequest {
  optional string workspace_canonical_path = 1;
}

message RegisterWorkspaceResponse {
  // no fields
}

message CreateWorkspaceRequest {
  optional string workspace_canonical_path = 1;
  optional string parent_cid = 2;
}

message CreateWorkspaceResponse {
  optional string canonical_path = 1;
}

message ListWorkspacesRequest {
  // no fields
}

message ListWorkspacesResponse {
  repeated string paths = 1;
  repeated WorkspaceSummary workspaces = 2;
}

message DeregisterWorkspaceRequest {
  optional string workspace_canonical_path = 1;
}

message DeregisterWorkspaceResponse {
  optional bool was_registered = 1;
}

message GetWorkspaceStatusRequest {
  optional string workspace_canonical_path = 1;
}

message WorkspaceStatusResponse {
  optional string path = 1;
  optional int64 registered_at_seconds = 2;
  repeated DiagnosticMessage diagnostics = 5;
  repeated MemberFetch members = 6;
  optional string build_input_cid = 7;
  optional string parent_cid = 9;
  optional string revision_cid = 10;
  repeated WorkspaceSequence sequences = 11;
  oneof _config_present {
    bool config_present = 3;
  }
  oneof _config_yaml {
    string config_yaml = 4;
  }
  oneof _options_json {
    string options_json = 8;
  }
}

message GetWorkspacePendingChangesRequest {
  optional string workspace_canonical_path = 1;
}

message PendingChange {
  optional string member = 1;
  optional PendingChangeKind kind = 2;
  optional string current_content = 3;
  optional string new_content = 4;
  optional map<string, string> metadata = 5;
  optional string error = 6;
}

message EditWorkspaceRequest {
  optional string workspace_canonical_path = 1;
  repeated WorkspaceEdit edits = 2;
}

message EditWorkspaceResponse {
  optional string config_yaml = 1;
  repeated WorkspaceSequence sequences = 2;
}

message AddWorkspaceMemberRequest {
  optional string workspace_canonical_path = 1;
  optional string name = 2;
  oneof source {
    GitMemberSource git = 3;
    ContainerMemberSource container = 4;
    string path = 5;
    string blob = 6;
  }
}

message AddWorkspaceMemberResponse {
  // no fields
}

message RemoveWorkspaceMemberRequest {
  optional string workspace_canonical_path = 1;
  optional string name = 2;
}

message RemoveWorkspaceMemberResponse {
  // no fields
}

message UpdateWorkspaceRequest {
  optional string workspace_canonical_path = 1;
  optional string key = 2;
  oneof _value {
    string value = 3;
  }
}

message UpdateWorkspaceResponse {
  // no fields
}

message PullWorkspaceMembersRequest {
  optional string workspace_canonical_path = 1;
  repeated string members = 2;
}

message PulledMember {
  optional string member = 1;
  optional PullKind kind = 2;
  optional string detail = 3;
}

message WorkspaceSummary {
  optional string path = 1;
  optional int64 last_active_seconds = 2;
  optional bool active = 3;
}

message DiagnosticMessage {
  optional DiagnosticLevel level = 1;
  optional string message = 2;
}

message MemberFetch {
  optional string name = 1;
  optional string path = 2;
  optional string cid = 3;
  optional int64 last_fetched_seconds = 4;
  optional int64 last_changed_seconds = 5;
  optional MemberStatus status = 6;
  optional string error = 7;
  optional TrackingInfo tracking = 8;
  optional bool local_checkout = 9;
  optional MemberDiffStatus diff_status = 10;
  optional bool inherited = 11;
  optional map<string, string> options = 12;
  repeated MemberOption option_details = 13;
}

message MemberOption {
  optional string key = 1;
  optional string value = 2;
  optional MemberOptionStatus status = 3;
}

message WorkspaceSequence {
  optional string name = 1;
  optional string value = 2;
  optional SequenceKind kind = 3;
}

message WorkspaceEdit {
  oneof op {
    SetOption set_option = 1;
    UnsetOption unset_option = 2;
    ResetOption reset_option = 3;
    SetMember set_member = 4;
    RemoveMember remove_member = 5;
    ResetMember reset_member = 6;
    ResetMemberPin reset_member_pin = 7;
    ResetMemberTracking reset_member_tracking = 8;
    SetMemberOption set_member_option = 9;
    UnsetMemberOption unset_member_option = 10;
    ResetMemberOption reset_member_option = 11;
    SetParent set_parent = 12;
    UnsetParent unset_parent = 13;
    CreateSequence create_sequence = 14;
    SetSequence set_sequence = 15;
    RemoveSequence remove_sequence = 16;
    BumpSequence bump_sequence = 17;
  }
}

message SetOption {
  optional string key = 1;
  optional string value = 2;
}

message UnsetOption {
  optional string key = 1;
}

message ResetOption {
  optional string key = 1;
}

message SetMember {
  optional string name = 1;
  oneof source {
    GitMemberSource git = 2;
    ContainerMemberSource container = 3;
    string path = 4;
    string blob = 5;
  }
}

message GitMemberSource {
  optional string url = 1;
  oneof _branch {
    string branch = 2;
  }
}

message ContainerMemberSource {
  optional string reference = 1;
  oneof _tag {
    string tag = 2;
  }
}

message RemoveMember {
  optional string name = 1;
}

message ResetMember {
  optional string name = 1;
}

message ResetMemberPin {
  optional string name = 1;
}

message ResetMemberTracking {
  optional string name = 1;
}

message SetMemberOption {
  optional string name = 1;
  optional string key = 2;
  optional string value = 3;
}

message UnsetMemberOption {
  optional string name = 1;
  optional string key = 2;
}

message ResetMemberOption {
  optional string name = 1;
  optional string key = 2;
}

message SetParent {
  optional string cid = 1;
}

message UnsetParent {
  // no fields
}

message CreateSequence {
  optional string name = 1;
  optional string value = 2;
}

message SetSequence {
  optional string name = 1;
  optional string value = 2;
}

message RemoveSequence {
  optional string name = 1;
}

message BumpSequence {
  optional string name = 1;
  optional SequenceComponent component = 2;
}

enum MemberStatus {
  MEMBER_STATUS_UNSPECIFIED = 0;
  MEMBER_STATUS_PENDING = 1;
  MEMBER_STATUS_FETCHING = 2;
  MEMBER_STATUS_FETCHED = 3;
  MEMBER_STATUS_FAILED = 4;
}

enum MemberDiffStatus {
  MEMBER_DIFF_STATUS_UNSPECIFIED = 0;
  MEMBER_DIFF_STATUS_UNCHANGED = 1;
  MEMBER_DIFF_STATUS_NEW = 2;
  MEMBER_DIFF_STATUS_CHANGED = 3;
  MEMBER_DIFF_STATUS_REMOVED = 4;
}

enum MemberOptionStatus {
  MEMBER_OPTION_STATUS_UNSPECIFIED = 0;
  MEMBER_OPTION_STATUS_UNCHANGED = 1;
  MEMBER_OPTION_STATUS_ADDED = 2;
  MEMBER_OPTION_STATUS_CHANGED = 3;
  MEMBER_OPTION_STATUS_REMOVED = 4;
}

enum SequenceKind {
  SEQUENCE_KIND_UNSPECIFIED = 0;
  SEQUENCE_KIND_INTEGER = 1;
  SEQUENCE_KIND_SEMVER = 2;
}

enum PendingChangeKind {
  PENDING_CHANGE_KIND_UP_TO_DATE = 0;
  PENDING_CHANGE_KIND_LOCAL_OVERRIDE = 1;
  PENDING_CHANGE_KIND_UPDATABLE = 2;
  PENDING_CHANGE_KIND_ERROR = 3;
  PENDING_CHANGE_KIND_NO_TRACKING = 4;
}

enum SequenceComponent {
  SEQUENCE_COMPONENT_UNSPECIFIED = 0;
  SEQUENCE_COMPONENT_BUILD = 1;
  SEQUENCE_COMPONENT_MINOR = 2;
  SEQUENCE_COMPONENT_MAJOR = 3;
}

enum PullKind {
  PULL_KIND_UNSPECIFIED = 0;
  PULL_KIND_UPDATED = 1;
  PULL_KIND_UP_TO_DATE = 2;
  PULL_KIND_NO_TRACKING = 3;
  PULL_KIND_ERROR = 4;
}