botond-veress / web-standards Goto Github PK

{
  "code": "POST_ARCHIVED",
  "message": "The post you are trying to add the comment to was archived."
}

Why do you use a string constant instead of a number for error codes?

Wouldn't make sense to implement a pagination mechanism where you are referencing the start of the page with the id of the last record from the previous page?

I'm not sure if the page index and count approach will work properly in case for example the number of elements changes (new is added, some older from whatever random page is deleted) and on the client-side you have already loaded a couple of pages.

What do you think?

I would like to see more details on the versioning, like:

• Numbering while in development.
• Differences in numbering on different environments (development, staging, production).
• Flows and examples on how to increment the version numbers in different states.

And so on.

Having these details set in stone will help a lot in the long run, especially around deployment and releases.

Explain what is the difference between status code 404 and 501. For example if I call the following endpoint: GET /psts/31 (note the typo!), which error will I get? 404 (psts endpoint not found) or 501 (psts action not implemented)?

On iOS the timestamp is stored in seconds. Will the server handle the conversion to/from milliseconds, or it should be handled by the client?

You should implement SSL certificate pinning whenever it is possible. It will prevent man-in-the-middle attacks. For more info check Rob Napier's talk: http://renaissance.io/2014/sessions/get_security_and_privacy_right (in the video there are two talks. Only the first talk is relevant.)

Should be

multiple resources have been created

instead of

multiple resources had been created

The java naming conventions suggest camel case.
Do we really want to force using snake case?

You forgot to mention this in the description of these methods.
This is important for beginners and not only.

Add a note saying booleans should always be serialised to true/false values.
This would be helpful for newcomers since I've seen the practice of serialising them to "true"/"false" strings at some companies.