Skip to content
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

Jump to bottom

Root API endpoint (/) 404 vs. offers direction #4497

Open
hlevring opened this issue Nov 19, 2024 · 2 comments · May be fixed by #4524
Open

Root API endpoint (/) 404 vs. offers direction #4497

hlevring opened this issue Nov 19, 2024 · 2 comments · May be fixed by #4524

Comments

@hlevring
Copy link

hlevring commented Nov 19, 2024 •
edited
Loading

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 hlevring added the bug Something isn't working label Nov 19, 2024
@github-project-automation github-project-automation bot moved this to Backlog in Backlog Nov 19, 2024
@birkjernstrom birkjernstrom changed the title https://api.polar.sh is broken Root API endpoint (/) does not exist Nov 19, 2024
@birkjernstrom birkjernstrom changed the title Root API endpoint (/) does not exist Root API endpoint (/) 404 vs. offers direction Nov 19, 2024
@birkjernstrom
Copy link
Member

(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 birkjernstrom removed the bug Something isn't working label Nov 19, 2024
@naineel1209 naineel1209 linked a pull request Nov 23, 2024 that will close this issue
Open
@naineel1209
Copy link
Contributor

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

@birkjernstrom birkjernstrom moved this from Backlog to In Progress in Backlog Dec 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
Backlog
Status: In Progress
Polar
Status: No status
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: enhance API Reference documentation and create / root endpoint naineel1209/polar
3 participants
@birkjernstrom @hlevring @naineel1209