Skip to content

Commit

Permalink
docs(cli): add todo comments regarding find_id
Browse files Browse the repository at this point in the history
Signed-off-by: Sandro-Alessio Gierens <[email protected]>
  • Loading branch information
gierens committed Jul 25, 2024
1 parent c18dd21 commit 21b85d0
Show file tree
Hide file tree
Showing 5 changed files with 16 additions and 0 deletions.
4 changes: 4 additions & 0 deletions src/cli/accounting/server_state.rs
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,7 @@ pub(crate) enum ServerStateCommand {
instance_name: String,

// TODO validate this
// TODO use find_id
#[clap(help = "ID of the flavor")]
flavor: u32,

Expand All @@ -64,6 +65,7 @@ pub(crate) enum ServerStateCommand {
status: String,

// TODO validate this
// TODO use find_id
#[clap(help = "ID of the user")]
user: u32,

Expand Down Expand Up @@ -101,6 +103,7 @@ pub(crate) enum ServerStateCommand {
short,
help = "Current flavor of the instance the server state belongs to"
)]
// TODO use find_id
flavor: Option<u32>,

// TODO we need some enum here
Expand All @@ -116,6 +119,7 @@ pub(crate) enum ServerStateCommand {
short,
help = "ID of the user the instance of the state belongs to"
)]
// TODO use find_id
user: Option<u32>,
},

Expand Down
3 changes: 3 additions & 0 deletions src/cli/budgeting/project_budget.rs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ pub(crate) struct ProjectBudgetListFilter {
help = "Display project budgets of user with given ID"
)]
// TODO validate that this is a valid user ID
// TODO use find_id
user: Option<u32>,

#[clap(
Expand All @@ -22,6 +23,7 @@ pub(crate) struct ProjectBudgetListFilter {
help = "Display project budgets of project with given ID"
)]
// TODO validate that this is a valid project ID
// TODO use find_id
project: Option<u32>,

#[clap(short, long, help = "Display all project budgets", action)]
Expand All @@ -46,6 +48,7 @@ pub(crate) enum ProjectBudgetCommand {
#[clap(about = "Create a new project budget")]
Create {
#[clap(help = "Id of the project of the budget")]
// TODO use find_id
project: u32,

#[clap(
Expand Down
1 change: 1 addition & 0 deletions src/cli/budgeting/user_budget.rs
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ pub(crate) enum UserBudgetCommand {
#[clap(about = "Create a new user budget")]
Create {
#[clap(help = "Id of the user of the budget")]
// TODO use find_id
user: u32,

#[clap(
Expand Down
2 changes: 2 additions & 0 deletions src/cli/pricing.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ pub(crate) enum FlavorPriceCommand {
#[clap(about = "Create a new flavor price")]
Create {
#[clap(help = "ID of the flavor of the price")]
// TODO use find_id
flavor: u32,

#[clap(help = "User class of the price (1-6)")]
Expand All @@ -35,6 +36,7 @@ pub(crate) enum FlavorPriceCommand {
id: u32,

#[clap(long, short, help = "Flavor the price belongs to")]
// TODO use find_id
flavor: Option<u32>,

#[clap(long, short, help = "User class of the price (1-6)")]
Expand Down
6 changes: 6 additions & 0 deletions src/cli/quota/flavor_quota.rs
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,12 @@ pub(crate) struct FlavorQuotaListFilter {
help = "Display flavor quotas of flavor group with given ID"
)]
// TODO validate that this is a valid group ID
// TODO use find_id
group: Option<u32>,

#[clap(short, long, help = "Display flavor quotas of user with given ID")]
// TODO validate that this is a valid user ID
// TODO use find_id
user: Option<u32>,
}

Expand All @@ -38,9 +40,11 @@ pub(crate) enum FlavorQuotaCommand {
#[clap(about = "Create a new flavor quota")]
Create {
#[clap(help = "ID of the flavor group")]
// TODO use find_id
flavor_group: u32,

#[clap(help = "ID of the user")]
// TODO use find_id
user: u32,

#[clap(long, short, help = "Amount of the quota")]
Expand All @@ -53,6 +57,7 @@ pub(crate) enum FlavorQuotaCommand {
id: u32,

#[clap(long, short, help = "User the quota is for")]
// TODO use find_id
user: Option<u32>,

#[clap(long, short, help = "Quota amount")]
Expand All @@ -63,6 +68,7 @@ pub(crate) enum FlavorQuotaCommand {
short,
help = "ID of the flavor group that should be limited"
)]
// TODO use find_id
flavor_group: Option<u32>,
},

Expand Down

0 comments on commit 21b85d0

Please sign in to comment.