Open NathanBland opened 7 years ago
Documentation has been updated with all currently existing endpoints.
We need to update the documentation with the changes made to /api/feed
.
We also need to add documentation for the /api/auth
endpoint.
You said you covered existing endpoints! I believed you! :cry:
But the existing feed docs are correct.
Done.
The documentation for /api/auth
doesn't match the rest of the docs.
Nor will it. There is not a resource
that is matched for auth, and it was initially classified as a special
api.
That's not the issue. The styling doesn't match.
In what way? It was copy pasted from lower items :thinking:
POST
/api/post
UserObject
POST
/api/auth/signup
username
and password
in the bodyUserObject
collection, as no duplicates are allowedusername: <String>
token: <String>
The primary difference being how return is noted?
I think I'd like to do something like this:
POST
/api/post
UserObject
for the created user.So a generic version would look like this:
REST
/path/to/endpoint
I think we may also want to consider documenting possible failures beyond the standard 404
s and such. So if we fail due to some business logic on the server, we return a 40x
error with a message of You done messed up
, etc.
All endpoints will return the error that caused the failure if they know what it is. (ie. validation error)
Also, if you add what you think each endpoint
should follow as a skeleton with some explanation at the top, it could serve as a helpful tool. For both people visiting the api doc so they know what to expect, and for us to add future endpoints
.
New api means docs need updated. #17
The docs currently are pretty awful.
@keawade has started the wiki pages to update this, and it needs done.
Issue for tracking....