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

Remove the curl documentation in the README.md #37

Closed
acabreragnz opened this issue Jul 30, 2019 · 1 comment
Closed

Remove the curl documentation in the README.md #37

acabreragnz opened this issue Jul 30, 2019 · 1 comment
Milestone

Comments

@acabreragnz
Copy link
Member

Although this API is about authentication, we are showing examples about the CRUD with TODO items. We should remove this section, because we already have the How to generate API documentation section.

authentication/README.md

Lines 25 to 31 in 6878f14

* this will run an HTTP server in port 8080, if you want to change this port you have to specify it through the environment variable (AUTH_SERVER_PORT) in the _.env_ file.
* For testing all the define endpoints you can try out these different CURL commands:
```bash
* Create: $ curl -H "Content-type: application/json" -d '{"i_am": "1", "title": "Some Todo Title", "the_rest": "description", "when_finish": "2018-12-06T14:26:40.623Z"}' "http://localhost:8080/todo"
* Read: $ curl -X GET "http://localhost:8080/todo/1"
* Update: $ curl -X PUT -H "Content-type: application/json" -d '{"i_am": "1", "title": "Some Todo Title", "the_rest": "description", "when_finish": "2018-12-06T14:26:40.623Z"}' "http://localhost:8080/todo"
* Delete: $ curl -X DELETE "http://localhost:8080/todo/1"

@jac1013
Copy link
Member

jac1013 commented Sep 3, 2019

I agree, good catch!

@jac1013 jac1013 added this to the 0.1 milestone Sep 3, 2019
@jac1013 jac1013 closed this as completed Mar 27, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants