Merge pull request #1059 from binggao1230/add-trace-to-path-keys

Recognize `trace` operations in docstrings

Author: lafrech

CHANGELOG.rst

@@ -6,6 +6,9 @@ unreleased
 
 Bug fixes:
 
+- Recognize ``trace`` operations defined in view docstrings, instead of
+  silently dropping them (:pr:`1059`).
+  Thanks :user:`binggao1230` for the PR.
 - Fix intersect ``OneOf`` and ``Equal`` choices in ``field2choices`` (:issue:`198`).
   Thanks :user:`alexchen-sys` for the PR.
 

src/apispec/yaml_utils.py

@@ -36,7 +36,7 @@ def load_yaml_from_docstring(docstring: str) -> dict:
     return yaml.safe_load(yaml_string) or {}
 
 
-PATH_KEYS = {"get", "put", "post", "delete", "options", "head", "patch"}
+PATH_KEYS = {"get", "put", "post", "delete", "options", "head", "patch", "trace"}
 
 
 def load_operations_from_docstring(docstring: str) -> dict:

tests/test_yaml_utils.py

@@ -29,6 +29,22 @@ def test_load_operations_from_docstring_empty_docstring(docstring):
     assert yaml_utils.load_operations_from_docstring(docstring) == {}
 
 
+@pytest.mark.parametrize(
+    "method", ("get", "put", "post", "delete", "options", "head", "patch", "trace")
+)
+def test_load_operations_from_docstring_path_methods(method):
+    docstring = f"""Foo.
+    ---
+    {method}:
+        responses:
+            200:
+                description: ok
+    """
+
+    operations = yaml_utils.load_operations_from_docstring(docstring)
+    assert operations == {method: {"responses": {200: {"description": "ok"}}}}
+
+
 def test_dict_to_yaml_unicode():
     assert yaml_utils.dict_to_yaml({"가": "나"}) == '"\\uAC00": "\\uB098"\n'
     assert yaml_utils.dict_to_yaml({"가": "나"}, {"allow_unicode": True}) == "가: 나\n"