docs: Add register_check to the API reference

schemathesis · Jan 13, 2021 · 8459dd9 · 8459dd9
1 parent 0fbf8e1
commit 8459dd9
Show file tree

Hide file tree

Showing 2 changed files with 17 additions and 1 deletion.
diff --git a/docs/api.rst b/docs/api.rst
@@ -1,6 +1,11 @@
 Public API reference
 ====================
 
+Checks
+~~~~~~
+
+.. autofunction:: schemathesis.register_check
+
 Fixups
 ~~~~~~
 
@@ -101,3 +106,4 @@ Open API-specific API
   :noindex:
 
   .. automethod:: add_link
+    :noindex:
diff --git a/src/schemathesis/cli/__init__.py b/src/schemathesis/cli/__init__.py
@@ -61,7 +61,17 @@ def register_target(function: Target) -> Target:
 
 
 def register_check(function: CheckFunction) -> CheckFunction:
-    """Register a new check for schemathesis CLI."""
+    """Register a new check for schemathesis CLI.
+
+    :param function: A function to validate API responses.
+
+    .. code-block:: python
+
+        @schemathesis.register_check
+        def new_check(response, case):
+            # some awesome assertions!
+            ...
+    """
     checks_module.ALL_CHECKS += (function,)
     CHECKS_TYPE.choices += (function.__name__,)  # type: ignore
     return function