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

The API documentation is outdated #782

Closed
zorun opened this issue Jul 7, 2021 · 3 comments
Closed

The API documentation is outdated #782

zorun opened this issue Jul 7, 2021 · 3 comments
Labels
doc help wanted low hanging fruits
Milestone
v5

Comments

@zorun
Copy link
Collaborator

zorun commented Jul 7, 2021

I was following the documentation of the API, and the current format of API responses is quite different from the documentation.

For instance the output of /api/projects/XXX is completly different from https://ihatemoney.readthedocs.io/en/latest/api.html#getting-information-about-the-project
@zorun zorun added this to the v5 milestone Jul 7, 2021
@erikkristoferanderson
Copy link
Contributor

I am interested in this issue, and will look around and evaluate whether I am able to help with it.

erikkristoferanderson added a commit to erikkristoferanderson/ihatemoney that referenced this issue Jul 30, 2021
@erikkristoferanderson
update api output (For issue spiral-project#782)
99a9ea1 
Updated the example API output for "Getting information about the project" in the documentation.
zorun pushed a commit that referenced this issue Aug 1, 2021
@erikkristoferanderson @zorun
update api output (For issue #782)
49d7903 
Updated the example API output for "Getting information about the project" in the documentation.
@zorun
Copy link
Collaborator Author

zorun commented Aug 1, 2021

Thanks for the first improvement! As discussed in #821 there may be more changes needed though.

@zorun
Copy link
Collaborator Author

zorun commented Oct 14, 2021

Done as part of #850

@zorun zorun closed this as completed Oct 14, 2021
TomRoussel pushed a commit to TomRoussel/ihatemoney that referenced this issue Mar 2, 2024
@erikkristoferanderson @zorun
update api output (For issue spiral-project#782)
8fab289 
Updated the example API output for "Getting information about the project" in the documentation.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
doc help wanted low hanging fruits
Projects
None yet
Milestone
v5
Development

No branches or pull requests
2 participants
@zorun @erikkristoferanderson