docs(id-support): Document that -p and -o arguments accept slugs and IDs #2101
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
src/api/errors/api_error.rs
Outdated
| @@ -24,7 +24,7 @@ pub(in crate::api) enum ApiErrorKind { | |||
| OrganizationNotFound, | |||
| #[error("resource not found")] | |||
| ResourceNotFound, | |||
| #[error("Project not found. Please check that you entered the project and organization slugs correctly.")] | |||
| #[error("Project not found. Please check that you entered the project and organization ids or slugs correctly.")] | |||
There was a problem hiding this comment.
Suggested change
| #[error("Project not found. Please check that you entered the project and organization ids or slugs correctly.")] | |
| #[error("Project not found. Please check that you entered the project and organization IDs or slugs correctly.")] |
src/config.rs
Outdated
| @@ -339,7 +339,7 @@ impl Config { | |||
| .get_from(Some("defaults"), "org") | |||
| .map(str::to_owned) | |||
| .ok_or_else(|| { | |||
| format_err!("An organization slug is required (provide with --org)") | |||
| format_err!("An organization id or slug is required (provide with --org)") | |||
There was a problem hiding this comment.
Suggested change
| format_err!("An organization id or slug is required (provide with --org)") | |
| format_err!("An organization ID or slug is required (provide with --org)") |
Please update anywhere else you have used lowercase id.
Co-authored-by: Daniel Szoke <7881302+szokeasaurusrex@users.noreply.github.com>
szokeasaurusrex
approved these changes
Jul 17, 2024
src/utils/args.rs
Outdated
| @@ -4,7 +4,7 @@ use clap::{Arg, ArgAction, Command}; | |||
|
|
|||
| fn validate_org(v: &str) -> Result<String, String> { | |||
| if v.contains('/') || v == "." || v == ".." || v.contains(' ') { | |||
| Err("Invalid value for organization. Use the URL slug and not the name!".to_string()) | |||
| Err("Invalid value for organization. Use the URL slug or the ID and not the name!".to_string()) | |||
There was a problem hiding this comment.
Suggested change
| Err("Invalid value for organization. Use the URL slug or the ID and not the name!".to_string()) | |
| Err("Invalid value for organization. Use the URL slug or the ID, not the name!".to_string()) |
Think this would read more clearly
| @@ -19,7 +19,7 @@ pub fn validate_project(v: &str) -> Result<String, String> { | |||
| || v.contains('\t') | |||
| || v.contains('\r') | |||
| { | |||
| Err("Invalid value for project. Use the URL slug and not the name!".to_string()) | |||
| Err("Invalid value for project. Use the URL slug or the ID and not the name!".to_string()) | |||
There was a problem hiding this comment.
Suggested change
| Err("Invalid value for project. Use the URL slug or the ID and not the name!".to_string()) | |
| Err("Invalid value for project. Use the URL slug or the ID, not the name!".to_string()) |
This was referenced Sep 10, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
With the API changes we made to support ids as well as slugs, we get the added bonus that our CLI can also support ids.
Turns out the CLI also uses a couple endpoints which passed project slug in the body parameter, so we also had to update them:
getsentry/sentry#74232
getsentry/sentry#74371
With these prs, all the endpoints the CLI uses have ID support.
@szokeasaurusrex and I had a conversation about how we would like to roll this change out in an earlier closed pr, and decided that once we support ids in all the CLI commands, we can change all the help strings at once, which is what i am doing here.