Skip to content
This repository has been archived by the owner on Mar 28, 2019. It is now read-only.

Commit

Permalink
Documentation improvments.
Browse files Browse the repository at this point in the history
  • Loading branch information
Rémy HUBSCHER committed Feb 26, 2016
1 parent 2e6097b commit ff77438
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 0 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,8 @@ This document describes changes between each past release.
per action is emitted when a transaction is committed (#634)
- Monitor time of events listeners execution (fixes #503)
- Add method to remove a principal from every user
- Validate that the client can accept JSON response. (#667)
- Validate that the client can only send JSON request body. (#667)

**Bug fixes**

Expand Down
10 changes: 10 additions & 0 deletions cliquet_docs/api/resource.rst
Original file line number Diff line number Diff line change
Expand Up @@ -333,6 +333,7 @@ HTTP Status Codes
* ``200 OK``: The request was processed
* ``304 Not Modified``: Collection did not change since value in ``If-None-Match`` header
* ``400 Bad Request``: The request querystring is invalid
* ``406 Not Acceptable``: The client doesn't accept supported responses Content-Type.
* ``412 Precondition Failed``: Collection changed since value in ``If-Match`` header


Expand Down Expand Up @@ -431,8 +432,10 @@ HTTP Status Codes
* ``201 Created``: The record was created
* ``400 Bad Request``: The request body is invalid
* ``406 Not Acceptable``: The client doesn't accept supported responses Content-Type.
* ``409 Conflict``: Unicity constraint on fields is violated
* ``412 Precondition Failed``: Collection changed since value in ``If-Match`` header
* ``415 Unsupported Media Type``: The client request was not sent with a correct Content-Type.


DELETE /{collection}
Expand Down Expand Up @@ -493,6 +496,7 @@ HTTP Status Codes

* ``200 OK``: The records were deleted;
* ``405 Method Not Allowed``: This endpoint is not available;
* ``406 Not Acceptable``: The client doesn't accept supported responses Content-Type.
* ``412 Precondition Failed``: Collection changed since value in ``If-Match`` header


Expand Down Expand Up @@ -547,6 +551,7 @@ HTTP Status Code

* ``200 OK``: The request was processed
* ``304 Not Modified``: Record did not change since value in ``If-None-Match`` header
* ``406 Not Acceptable``: The client doesn't accept supported responses Content-Type.
* ``412 Precondition Failed``: Record changed since value in ``If-Match`` header


Expand Down Expand Up @@ -583,6 +588,7 @@ HTTP Status Code
----------------

* ``200 OK``: The record was deleted
* ``406 Not Acceptable``: The client doesn't accept supported responses Content-Type.
* ``412 Precondition Failed``: Record changed since value in ``If-Match`` header


Expand Down Expand Up @@ -657,9 +663,11 @@ HTTP Status Code
* ``201 Created``: The record was created
* ``200 OK``: The record was replaced
* ``400 Bad Request``: The record is invalid
* ``406 Not Acceptable``: The client doesn't accept supported responses Content-Type.
* ``409 Conflict``: If replacing this record violates a field unicity constraint
* ``412 Precondition Failed``: Record was changed or deleted since value
in ``If-Match`` header.
* ``415 Unsupported Media Type``: The client request was not sent with a correct Content-Type.

.. note::

Expand Down Expand Up @@ -764,8 +772,10 @@ HTTP Status Code
* ``200 OK``: The record was modified
* ``400 Bad Request``: The request body is invalid, or a read-only field was
modified
* ``406 Not Acceptable``: The client doesn't accept supported responses Content-Type.
* ``409 Conflict``: If modifying this record violates a field unicity constraint
* ``412 Precondition Failed``: Record changed since value in ``If-Match`` header
* ``415 Unsupported Media Type``: The client request was not sent with a correct Content-Type.


.. _resource-permissions-attribute:
Expand Down

0 comments on commit ff77438

Please sign in to comment.