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

[docs] Basic API instructions #114

Closed
nemesifier opened this issue May 11, 2020 · 0 comments · Fixed by #117
Closed

[docs] Basic API instructions #114

nemesifier opened this issue May 11, 2020 · 0 comments · Fixed by #117
Assignees
@PabloCastellano
Labels
enhancement
Projects
REST API

Comments

@nemesifier
Copy link
Member

I think to find a good balance between documentation and maintenance, we should enable swagger and add some basic instructions in the README regarding the API, listing the available API endpoints and briefly explain how to find out their details using swagger.

Right now we only have 1 endpoint but I'll start creating issues about adding more endpoints (eg: CRUD for User, CRUD for Organization, etc).

If this works we should adopt it as a general methodology for all the modules.
@nemesifier nemesifier mentioned this issue May 11, 2020
Closed
@nemesifier nemesifier added this to To do in REST API May 13, 2020
PabloCastellano added a commit that referenced this issue May 13, 2020
@PabloCastellano
[docs] Basic API instructions #114
a8ceadd 
 Closes #114
@PabloCastellano PabloCastellano mentioned this issue May 13, 2020
Merged
@PabloCastellano PabloCastellano moved this from To do to Open Pull-Requests in REST API May 13, 2020
@PabloCastellano PabloCastellano moved this from Open Pull-Requests to Ready for review in REST API May 14, 2020
REST API automation moved this from Ready for review to Done May 15, 2020
nemesifier pushed a commit that referenced this issue May 15, 2020
@PabloCastellano
[docs] Basic API instructions #114 (#117)
e63b023 
Closes #114
pandafy pushed a commit that referenced this issue Jan 12, 2021
@devkapilbansal
[docs] Fixed command not installing dependencies #114
b6fb5a8 
Replaced develop command with pip to install extra_requires in development version.

Closes #114
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@PabloCastellano PabloCastellano

Labels
enhancement
Projects
No open projects
REST API
  
Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

[docs] Basic API instructions #114 openwisp/openwisp-users
2 participants
@PabloCastellano @nemesifier