Skip to content

Change segment ID to company ID in API payloads for Ripple #867

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

Merged
gsamuya merged 1 commit into from
May 6, 2026
Merged

Change segment ID to company ID in API payloads for Ripple #867

Show file tree
Hide file tree
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
20 changes: 13 additions & 7 deletions gc/v1/gc.proto
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ service GuaranteedCommitments {
}


// DEVELOPER'S NOTE: FOR Infrastructure Plan
// DEVELOPER'S NOTE: FOR Infrastructure Plan.USED FOR RIPPLE ONLY

// WORK-IN-PROGRESS: Only works for Alphaus for now. Retrieves a paginated list of reservable infrastructure resources for a segment.
// Supports filtering, sorting, and a date range for usage aggregation.
Expand Down Expand Up @@ -143,6 +143,9 @@ service GuaranteedCommitments {
body: "*"
};
}


// USED FOR RIPPLE AND WAVEPRO

// WORK-IN-PROGRESS: Retrieves the drafted purchase plans
rpc ListDraftPurchasePlans(ListDraftPurchasePlansRequest) returns (ListDraftPurchasePlansResponse) {
Expand All @@ -151,6 +154,7 @@ service GuaranteedCommitments {
};
}

// USED FOR RIPPLE ONLY

// WORK-IN-PROGRESS: Deletes a drafted purchase plan.
rpc DeleteDraftPurchasePlan(DeleteDraftPurchasePlanRequest) returns (DeleteDraftPurchasePlanResponse) {
Expand All @@ -160,7 +164,7 @@ service GuaranteedCommitments {
}


// DEVELOPER'S NOTE: FOR Infrastructure Plan and custom (top-down) commitment plan
// DEVELOPER'S NOTE: FOR Infrastructure Plan and custom (top-down) commitment plan. USED FOR RIPPLE ONLY

// WORK-IN-PROGRESS: Only works for Alphaus for now. Retrieves the available commitment types for a given provider.
rpc GetAvailableCommitmentTypes(GetAvailableCommitmentTypesRequest) returns (GetAvailableCommitmentTypesResponse) {
Expand All @@ -169,7 +173,7 @@ service GuaranteedCommitments {
};
}

// DEVELOPER'S NOTE: FOR Infrastructure Plan and custom (top-down) commitment plan
// DEVELOPER'S NOTE: FOR Infrastructure Plan and custom (top-down) commitment plan. USED FOR RIPPLE ONLY

// WORK-IN-PROGRESS: Only works for Alphaus for now. Creates a custom (top-down) commitment purchase plan.
rpc CreateCustomCommitmentPlan(CreateCustomCommitmentPlanRequest) returns (DefaultPurchasePlan) {
Expand Down Expand Up @@ -471,8 +475,8 @@ message GetResourceDailyUsageRequest {
}

message ListReservableResourcesRequest {
// Required. The segment ID to scope the query to.
string segmentId = 1;
// Required. The company ID to scope the query to.
string companyId = 1;
// // Optional. Field to sort by. Example: "ondemand_cost".
// string orderBy = 2;
// // Optional. If true, sort in descending order.
Expand Down Expand Up @@ -697,11 +701,13 @@ message SaveCommitmentsPlanAsDraftRequest {
message ListDraftPurchasePlansRequest {
// If set to true, returns plans with Draft status. If set to false, returns plans with Submitted and Executed status.
bool isDraft = 1;
string companyId = 2;
}

message DeleteDraftPurchasePlanRequest {
// Required. The draft plan ID to delete.
string draftPlanId = 1;
string companyId = 2;
}

message GetAvailableCommitmentTypesRequest {
Expand All @@ -718,8 +724,8 @@ message CreateCustomCommitmentPlanRequest {
string startDate = 2;
// Required. ISO 8601 lookback window end timestamp (e.g. "2026-04-16T02:43:39.717Z").
string endDate = 3;
// Required. The segment ID to scope the plan to.
string segmentId = 4;
// Required. The company ID to scope the plan to.
string companyId = 4;
// Plan status. Use "draft" to save without submitting.
// Acceptable values: "draft", "submitted".
string status = 5;
Expand Down
Loading
Loading