deploy: 64b0b17

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 5bad9f5f398c5499f5febea01631b3c9
+tags: 645f666f9bcd5a90fca523b33c5a78b7

_sources/api_filtering_example.rst.txt

@@ -0,0 +1,87 @@
+Filtering API example
+======================
+
+.. literalinclude:: ../examples/custom_filter_example.py
+    :language: python
+
+
+
+Filter by jsonb contains
+
+.. code-block:: json
+
+    [
+      {
+        "name": "words",
+        "op": "jsonb_contains",
+        "val": {"location": "Moscow", "spam": "eggs"}
+      }
+    ]
+
+Request:
+
+.. literalinclude:: ./http_snippets/snippets/api_filtering__get_users__filter_word_contains_in_array
+  :language: HTTP
+
+Response:
+
+.. literalinclude:: ./http_snippets/snippets/api_filtering__get_users__filter_word_contains_in_array_result
+  :language: HTTP
+
+
+Other examples
+--------------
+
+.. code-block:: python
+
+    # pseudo-code
+
+    class User:
+        name: str = ...
+        words: list[str] = ...
+
+
+Filter by word
+
+.. code-block:: json
+
+    [
+      {
+        "name": "words",
+        "op": "in",
+        "val": "spam"
+      }
+    ]
+
+Request:
+
+.. literalinclude:: ./http_snippets/snippets/api_filtering__get_users__filter_word_in_array
+  :language: HTTP
+
+Response:
+
+.. literalinclude:: ./http_snippets/snippets/api_filtering__get_users__filter_word_in_array_result
+  :language: HTTP
+
+
+Filter by words
+
+.. code-block:: json
+
+    [
+      {
+        "name": "words",
+        "op": "in",
+        "val": ["bar", "eggs"]
+      }
+    ]
+
+Request:
+
+.. literalinclude:: ./http_snippets/snippets/api_filtering__get_users__filter_words_in_array
+  :language: HTTP
+
+Response:
+
+.. literalinclude:: ./http_snippets/snippets/api_filtering__get_users__filter_words_in_array_result
+  :language: HTTP

_sources/api_limited_methods_example.rst.txt

@@ -0,0 +1,46 @@
+.. _api_limited_methods_example:
+
+Limit API methods
+#################
+
+Sometimes you won't need all the CRUD methods.
+For example, you want to create only GET, POST and GET LIST methods,
+so user can't update or delete any items.
+
+
+Set ``methods`` on Routers registration:
+
+.. code-block:: python
+
+    RoutersJSONAPI(
+        router=router,
+        path="/users",
+        tags=["User"],
+        class_detail=UserDetailView,
+        class_list=UserListView,
+        schema=UserSchema,
+        model=User,
+        resource_type="user",
+        methods=[
+            RoutersJSONAPI.Methods.GET_LIST,
+            RoutersJSONAPI.Methods.POST,
+            RoutersJSONAPI.Methods.GET,
+        ],
+    )
+
+
+This will limit generated views to:
+
+========================  ======  =============  ===========================
+URL                       method  endpoint       Usage
+========================  ======  =============  ===========================
+/users                    GET     user_list      Get a collection of users
+/users                    POST    user_list      Create a user
+/users/{user_id}          GET     user_detail    Get user details
+========================  ======  =============  ===========================
+
+
+Full code example (should run "as is"):
+
+.. literalinclude:: ../examples/api_limited_methods.py
+    :language: python