Skip to content

Document alternative API endpoints in README#12

Open
gugu wants to merge 1 commit intomainfrom
docs/alternative-api-endpoints
Open

Document alternative API endpoints in README#12
gugu wants to merge 1 commit intomainfrom
docs/alternative-api-endpoints

Conversation

@gugu
Copy link
Copy Markdown
Member

@gugu gugu commented Apr 2, 2026

No description provided.

Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR updates the SDK documentation to list alternative Short.io API base URLs so users can target the appropriate endpoint (default, enterprise, or China) when configuring the browser client.

Changes:

  • Added an “Alternative API endpoints” section to the createClient(config) documentation.
  • Documented three base URL options and their intended use cases.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread README.md
Comment on lines +66 to +72
**Alternative API endpoints:**

| Endpoint | Use case |
|----------|----------|
| `https://api.short.io` | Default — standard API |
| `https://enterprise-api.short.io` | Enterprise customers with dedicated IPs |
| `https://api.shortio.cn` | Users in mainland China |
Copy link

Copilot AI Apr 2, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The alternative endpoints list is not clearly tied back to config.baseUrl. Consider adding a short sentence here explaining that users should set createClient({ baseUrl: ... }) to one of these values (and whether a trailing slash is expected), otherwise the table is a bit ambiguous about how to apply it.

Copilot uses AI. Check for mistakes.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants