Skip to content

Implement AuthenticationError #16

Open
Open
Implement AuthenticationError#16
Labels
GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official Campaignarea:errorspriority:p1type:feature

Description

@codebestia
codebestia
opened on Jun 20, 2026

Description

Raised when the API key is missing, malformed, or rejected by the server (HTTP 401). Should tell the developer exactly what is wrong: missing key, wrong key format, or key revoked.

Proposed Steps

  • Define AuthenticationError(ShadeError) in errors.py.
  • Carry an optional hint field with corrective guidance (e.g. "Check that you're using a secret key, not a public key").
  • The HTTP client raises this on 401 responses.
  • Config validation also raises this before any network call.

Acceptance Criteria

  • A 401 API response raises AuthenticationError.
  • error.hint contains actionable guidance.
  • Raised immediately when shade.api_key is None and a resource method is called.
  • Subclasses ShadeError.

Activity

  1. codebestia
    added
    type:feature
    priority:p1
    area:errors
    on Jun 20, 2026

  2. Enemuo-debug commented on Jun 20, 2026

    @Enemuo-debug
    Enemuo-debug
    on Jun 20, 2026 – with GrantFox OSS

    Can I please be opportuned to work on this??

  3. grantfox-oss
    added
    GrantFox OSSIssue tracked in GrantFox OSS
    Maybe RewardedIssue may be eligible for a GrantFox reward
    Official CampaignCampaign: Official Campaign
    on Jun 20, 2026
  4. grantfox-oss
    assigned
    Enemuo-debug
    on Jun 23, 2026

  5. grantfox-oss commented on Jun 23, 2026

    @grantfox-oss
    grantfox-ossBot
    on Jun 23, 2026 – with GrantFox OSS

    🦊 GrantFox — @Enemuo-debug has been assigned to this issue as part of the Official Campaign campaign!

    Next steps:

    1. Open a Pull Request referencing this issue (e.g., Closes #16)
    2. Your PR will be reviewed by the ShadeProtocol maintainers

    Good luck! Track your progress on GrantFox.

  6. codebestia commented on Jun 26, 2026

    @codebestia
    codebestia
    on Jun 26, 2026
    ContributorAuthor

    Hello @Enemuo-debug
    What's the update with this task?

  7. codebestia
    unassigned
    Enemuo-debug
    on Jul 20, 2026

  8. rupesh-kumar-sah commented on Sep 14, 2026

    @rupesh-kumar-sah
    rupesh-kumar-sah
    on Sep 14, 2026

    Hi everyone,

    I can tackle Implement AuthenticationError``. Proposed implementation roadmap:

    • Analysis: Inspect current behavior and edge cases in ShadeProtocol/shade-python
    • Core Implementation: Trace the regression in ShadeProtocol/shade-python causing Implement AuthenticationError`` and implement a targeted, minimal fix.
    • Quality Assurance: Add a reproduction test case to prevent any future regression.

    Looking forward to contributing—please feel free to assign!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    GrantFox OSSIssue tracked in GrantFox OSSMaybe RewardedIssue may be eligible for a GrantFox rewardOfficial CampaignCampaign: Official Campaignarea:errorspriority:p1type:feature

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions