Skip to content

feat(setup): add SetupStatus enum with lifecycle management #79

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
bbbouvier wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

feat(setup): add SetupStatus enum with lifecycle management #79

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 30 additions & 1 deletion proto/digitalkin/setup/v2/setup.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,29 @@ import "google/api/field_behavior.proto";
import "google/protobuf/struct.proto";
import "google/protobuf/timestamp.proto";

// SetupStatus
// Represents the status of a setup.
enum SetupStatus {
// DRAFT: Setup is a draft
DRAFT = 0;
// VALIDATING: Setup is being validated
VALIDATING = 1;
// READY: Setup is ready
READY = 2;
// PAUSED: Setup is paused
PAUSED = 4;
// FAILED: Setup failed
FAILED = 5;
// ARCHIVED: Setup has been archived
ARCHIVED = 6;
// NEEDS_CONFIGURATION: Setup needs configuration
NEEDS_CONFIGURATION = 7;
// CONFIGURATION_FAILED: Setup configuration failed
CONFIGURATION_FAILED = 8;
// CONFIGURATION_SUCCEEDED: Setup configuration succeeded
CONFIGURATION_SUCCEEDED = 9;
}

// SetupVersion
// Represents a version of a setup's configuration.
//
Expand Down Expand Up @@ -70,6 +93,8 @@ message Setup {
string module_id = 5 [(buf.validate.field).required = true];
// current_setup_version: The unique identifier of the active setup version.
optional SetupVersion current_setup_version = 6;
// status: The status of the setup.
SetupStatus status = 7 [(buf.validate.field).required = true];
}

// CreateSetupRequest
Expand All @@ -92,6 +117,8 @@ message CreateSetupRequest {
string module_id = 4 [(buf.validate.field).required = true];
// current_setup_version: The unique identifier of the active setup version.
optional SetupVersion current_setup_version = 5;
// status: The status of the setup.
SetupStatus status = 6 [(buf.validate.field).required = true];
}

// CreateSetupResponse
Expand Down Expand Up @@ -149,6 +176,8 @@ message UpdateSetupRequest {
string owner_id = 3;
// current_setup_version: The unique identifier of the active setup version.
SetupVersion current_setup_version = 4;
// status: The status of the setup.
SetupStatus status = 5 [(buf.validate.field).required = true];
}

// UpdateSetupResponse
Expand Down Expand Up @@ -327,4 +356,4 @@ message ListSetupsResponse {
int32 list_size = 1 [(buf.validate.field).int32.gte = 0];
// setups: List of setups with their details.
repeated Setup setups = 2;
}
}