polar icon indicating copy to clipboard operation
polar copied to clipboard

Root API endpoint (`/`) 404 vs. offers direction

Open hlevring opened this issue 1 year ago • 2 comments
trafficstars

Description

https://api.polar.sh is broken

Current Behavior

If you visit https://docs.polar.sh/api#feedback Clicking https://api.polar.sh/ shows a page saying "details not found"

Expected Behavior

Link should work

Screenshots

image

Environment:

  • Operating System: Windows 11
  • Browser : Chrome

hlevring avatar Nov 19 '24 14:11 hlevring

(Updated title a bit)

Thank you @hlevring. We should make sure the reference to the API url is not an actual link in the docs & spruce up the index page on: docs.polar.sh/api to provide more initial direction like docs.polar.sh/developers

But the API definitely works and has a lot of endpoints available to integrate Polar & manage your organization and store. You can follow our (https://docs.polar.sh/developers) for examples.

We should, however, offer a more friendly response under the non-existent / root endpoint of our API with suggestions on the first guides or something to review. Would be a nice & nerdy enhancement 🤓

birkjernstrom avatar Nov 19 '24 16:11 birkjernstrom

hi @birkjernstrom, I've created a PR that will resolve this, kindly take a look.

naineel1209 avatar Nov 23 '24 11:11 naineel1209