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.

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

Create docs with all known endpoints #12

Open
matin opened this issue Sep 29, 2023 · 5 comments
Open

Create docs with all known endpoints #12

matin opened this issue Sep 29, 2023 · 5 comments

Comments

@matin
Copy link
Owner

matin commented Sep 29, 2023

While Garth will support some endpoints natively, it's impractical and slow to add all endpoints.

The faster method is to create a wiki with all known endpoints. The most popular can then be added directly into the library. Others can simply use garth.connectapi(path).

@matin matin changed the title Create a wiki with all known endpoints Create docs with all known endpoints Sep 29, 2023
@matin
Copy link
Owner Author

matin commented Sep 29, 2023

This would actually be better solved by creating proper documentation outside of the README. We could use readthedocs or mkdocs.

@matin
Copy link
Owner Author

matin commented Oct 18, 2023

For the time being, I recommend the growing list of endpoints in cyberjunky/python-garminconnect.

@zimengzhou1
Copy link

Where are these endpoints coming from? Is there some documentation from Garmin?

@matin
Copy link
Owner Author

matin commented Feb 15, 2024

@zimengzhou1 the easiest way imho is to use the app with Charles Proxy and monitor what endpoints the app is using

@matin
Copy link
Owner Author

matin commented Feb 20, 2024

#48 outlines the Garmin Golf endpoints

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

No branches or pull requests

2 participants