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

API docs #220

Merged
merged 16 commits into from Jul 17, 2017
Merged

API docs #220

merged 16 commits into from Jul 17, 2017

Conversation

mayhem
Copy link
Member

@mayhem mayhem commented Jul 6, 2017

I moved the setup.py copying code into the app_create for rtdocs and things are much cleaner now. Hopefully good to go for beta now.

@mayhem mayhem changed the title [WIP] Api docs API docs Jul 16, 2017
docs/dev/api.rst Outdated
**Root URL**: ``https://api.listenbrainz.org``
**Beta Root URL**: ``https://beta-api.listenbrainz.org``

While we are in beta testing, to submit to our beta server use this root URL:
Copy link
Collaborator

Choose a reason for hiding this comment

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

This is a bit confusing, if we are in beta, do we want data sent to api.listenbrainz.org or beta-api.listenbrainz.org?

Copy link
Collaborator

Choose a reason for hiding this comment

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

I would expect beta-api.lb but the doc seems to say api.lb?

@@ -1,8 +1,6 @@
ListenBrainz' API documentation
===============================

```NOTE: THIS DOCUMENTATION IS NOT OFFICIAL YET!```
Copy link
Collaborator

Choose a reason for hiding this comment

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

🎉

@mayhem mayhem merged commit 9d3a24c into master Jul 17, 2017
@mayhem mayhem deleted the api-docs branch July 28, 2017 11:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants