Skip to content

Add shade.api_base override support #6

Closed

Description

@codebestia

Description

Teams running a self-hosted Shade backend or a staging environment at a custom URL need to override the default API base without changing the environment enum. shade.api_base should provide an escape hatch that takes precedence over the URL resolved from Environment.

Proposed Steps

  • Add api_base: Optional[str] = None to ShadeClient and config.py.
  • In the HTTP client URL builder, prefer api_base when set, otherwise fall back to the Environment-resolved URL.
  • Trim trailing slashes on the provided value.
  • Document that this is intended for development/testing only.

Acceptance Criteria

  • shade.api_base = "https://staging.shadeprotocol.io" routes all requests to that host.
  • ShadeClient(api_base="http://localhost:8000") routes that client's requests locally.
  • When api_base is set, Environment still controls the Stellar network passphrase.
  • Trailing slashes in the provided URL are normalized.

Activity

  1. xx7412421-cloud commented on Jun 21, 2026

    @xx7412421-cloud

    I'd like to take this on if assignment is available. I can keep it scoped to the API base override, trailing-slash normalization, tests, and docs.

  2. Tijesunimi004 commented on Jun 25, 2026

    @Tijesunimi004
    Contributor

    I have experience with Open Source and would like to work on this issue

  3. grantfox-oss commented on Jun 25, 2026

    @grantfox-oss

    🦊 GrantFox — @Tijesunimi004 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 #6)
    2. Your PR will be reviewed by the ShadeProtocol maintainers

    Good luck! Track your progress on GrantFox.

  4. grantfox-oss commented on Jun 26, 2026

    @grantfox-oss

    🎉 This issue has been marked as completed on GrantFox as part of the Official Campaign campaign!

    @Tijesunimi004's PR #29 was approved and merged by @codebestia.

    🏆 @Tijesunimi004: You earned 35 FoxPoints for this contribution! Your current tier: Explorer (258 total points). Track your full progress on GrantFox.

    👏 Great work, @Tijesunimi004! Keep contributing to ShadeProtocol.

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

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions