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

Commit

Permalink
added _hidden_fields to doc
Browse files Browse the repository at this point in the history
  • Loading branch information
jstoiko committed Sep 27, 2015
1 parent deae3f9 commit cea9234
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/schemas.rst
Original file line number Diff line number Diff line change
Expand Up @@ -20,14 +20,15 @@ All Ramses-specific properties are prefixed with an underscore.
Showing Fields
--------------

If you've enabled authentication, you can list which fields to return to authenticated users in ``_auth_fields`` and to non-authenticated users in ``_public_fields``.
If you've enabled authentication, you can list which fields to return to authenticated users in ``_auth_fields`` and to non-authenticated users in ``_public_fields``. Additionaly, you can list fields to be hidden but remain hidden (with proper persmissions) in ``_hidden_fields``.

.. code-block:: json
{
(...)
"_auth_fields": ["id", "name", "description"],
"_public_fields": ["name"],
"_hidden_fields": ["token"],
(...)
}
Expand Down

0 comments on commit cea9234

Please sign in to comment.