Skip to content

fix: update error messages to specify "Invalid GitGuardian API key" #1120

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
merged 1 commit into from
Aug 14, 2025
Merged

fix: update error messages to specify "Invalid GitGuardian API key" #1120

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
2 changes: 1 addition & 1 deletion ggshield/core/client.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -108,7 +108,7 @@ def check_client_api_key(client: GGClient, required_scopes: set[TokenScope]) ->
# None means success
pass
elif response.status_code == 401:
raise APIKeyCheckError(client.base_uri, "Invalid API key.")
raise APIKeyCheckError(client.base_uri, "Invalid GitGuardian API key.")
elif response.status_code == 404:
raise UnexpectedError(
"The server returned a 404 error. Check your instance URL settings.",
Expand Down
4 changes: 3 additions & 1 deletion tests/unit/cmd/auth/test_login.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,9 @@
}
)

INVALID_TOKEN_RESPONSE = create_json_response({"detail": "Invalid API key."}, 401)
INVALID_TOKEN_RESPONSE = create_json_response(
{"detail": "Invalid GitGuardian API key."}, 401
)

METADATA_ENDPOINT = "/v1/metadata"

Expand Down
2 changes: 1 addition & 1 deletion tests/unit/verticals/secret/test_secret_scanner.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -170,7 +170,7 @@ def test_scanner_skips_unscannable_files(client, fs, cache, unscannable_type: st


def test_handle_scan_error_api_key():
detail = Detail("Invalid API key.")
detail = Detail("Invalid GitGuardian API key.")
detail.status_code = 401
with pytest.raises(click.UsageError):
handle_scan_chunk_error(detail, [])
Expand Down