Render JSON schema description

Render JSON request/response JSON schema descriptions using httpdomain's
'<json' and '>json' field lists. There are couple of nuances though.
First, only JSON object and JSON arrays are supported on top level. That
said, if your endpoint returns a bare number of string, the description
won't be rendered. Second, the description is rendered only for 2XX
status code. It won't be rendered for anything else.

Author: ikalnytskyi

setup.py

@@ -32,6 +32,7 @@
         "jsonschema >= 2.5.1",
         "m2r >= 0.2",
         "picobox >= 2.2",
+        "deepmerge >= 0.1",
     ],
     project_urls={
         "Documentation": "https://sphinxcontrib-openapi.readthedocs.io/",

sphinxcontrib/openapi/renderers/_httpdomain.py

@@ -1,10 +1,12 @@
 """OpenAPI spec renderer."""
 
 import collections
+import copy
 import functools
 import http.client
 import json
 
+import deepmerge
 import docutils.parsers.rst.directives as directives
 import m2r
 import requests
@@ -112,21 +114,72 @@ def _get_markers_from_object(oas_object, schema):
 
     markers = []
 
-    if schema.get("type"):
-        type_ = schema["type"]
+    schema_type = _get_schema_type(schema)
+    if schema_type:
         if schema.get("format"):
-            type_ = f"{type_}:{schema['format']}"
-        markers.append(type_)
+            schema_type = f"{schema_type}:{schema['format']}"
+        elif schema.get("enum"):
+            schema_type = f"{schema_type}:enum"
+        markers.append(schema_type)
+    elif schema.get("enum"):
+        markers.append("enum")
 
     if oas_object.get("required"):
         markers.append("required")
 
     if oas_object.get("deprecated"):
         markers.append("deprecated")
 
+    if schema.get("deprecated"):
+        markers.append("deprecated")
+
     return markers
 
 
+def _is_json_mimetype(mimetype):
+    """Returns 'True' if a given mimetype implies JSON data."""
+
+    return any(
+        [
+            mimetype == "application/json",
+            mimetype.startswith("application/") and mimetype.endswith("+json"),
+        ]
+    )
+
+
+def _is_2xx_status(status_code):
+    """Returns 'True' if a given status code is one of successful."""
+
+    return str(status_code).startswith("2")
+
+
+def _get_schema_type(schema):
+    """Retrieve schema type either by reading 'type' or guessing."""
+
+    # There are a lot of OpenAPI specs out there that may lack 'type' property
+    # in their schemas. I fount no explanations on what is expected behaviour
+    # in this case neither in OpenAPI nor in JSON Schema specifications. Thus
+    # let's assume what everyone assumes, and try to guess schema type at least
+    # for two most popular types: 'object' and 'array'.
+    if "type" not in schema:
+        if "properties" in schema:
+            schema_type = "object"
+        elif "items" in schema:
+            schema_type = "array"
+        else:
+            schema_type = None
+    else:
+        schema_type = schema["type"]
+    return schema_type
+
+
+_merge_mappings = deepmerge.Merger(
+    [(collections.Mapping, deepmerge.strategy.dict.DictStrategies("merge"))],
+    ["override"],
+    ["override"],
+).merge
+
+
 class HttpdomainRenderer(abc.RestructuredTextRenderer):
     """Render OpenAPI v3 using `sphinxcontrib-httpdomain` extension."""
 
@@ -143,6 +196,7 @@ class HttpdomainRenderer(abc.RestructuredTextRenderer):
         "request-example-preference": None,
         "response-example-preference": None,
         "generate-examples-from-schemas": directives.flag,
+        "no-json-schema-description": directives.flag,
     }
 
     def __init__(self, state, options):
@@ -171,6 +225,7 @@ def __init__(self, state, options):
             "response-example-preference", self._example_preference
         )
         self._generate_example_from_schema = "generate-examples-from-schemas" in options
+        self._json_schema_description = "no-json-schema-description" not in options
 
     def render_restructuredtext_markup(self, spec):
         """Spec render entry point."""
@@ -281,6 +336,15 @@ def render_parameter(self, parameter):
     def render_request_body(self, request_body, endpoint, method):
         """Render OAS operation's requestBody."""
 
+        if self._json_schema_description:
+            for content_type, content in request_body["content"].items():
+                if _is_json_mimetype(content_type) and content.get("schema"):
+                    yield from self.render_json_schema_description(
+                        content["schema"], "req"
+                    )
+                    yield ""
+                    break
+
         yield from self.render_request_body_example(request_body, endpoint, method)
         yield ""
 
@@ -312,6 +376,18 @@ def render_request_body_example(self, request_body, endpoint, method):
     def render_responses(self, responses):
         """Render OAS operation's responses."""
 
+        if self._json_schema_description:
+            for status_code, response in responses.items():
+                if _is_2xx_status(status_code):
+                    for content_type, content in response.get("content", {}).items():
+                        if _is_json_mimetype(content_type) and content.get("schema"):
+                            yield from self.render_json_schema_description(
+                                content["schema"], "res"
+                            )
+                            yield ""
+                            break
+                    break
+
         for status_code, response in responses.items():
             # Due to the way how YAML spec is parsed, status code may be
             # infered as integer. In order to spare some cycles on type
@@ -409,3 +485,136 @@ def render_response_example(self, media_type, status_code):
             yield f"   Content-Type: {content_type}"
             yield f""
             yield from indented(example.splitlines())
+
+    def render_json_schema_description(self, schema, req_or_res):
+        """Render JSON schema's description."""
+
+        def _resolve_combining_schema(schema):
+            if "oneOf" in schema:
+                # The part with merging is a vague one since I only found a
+                # single 'oneOf' example where such merging was assumed, and no
+                # explanations in the spec itself.
+                merged_schema = schema.copy()
+                merged_schema.update(merged_schema.pop("oneOf")[0])
+                return merged_schema
+
+            elif "anyOf" in schema:
+                # The part with merging is a vague one since I only found a
+                # single 'oneOf' example where such merging was assumed, and no
+                # explanations in the spec itself.
+                merged_schema = schema.copy()
+                merged_schema.update(merged_schema.pop("anyOf")[0])
+                return merged_schema
+
+            elif "allOf" in schema:
+                # Since the item is represented by all schemas from the array,
+                # the best we can do is to render them all at once
+                # sequentially. Please note, the only way the end result will
+                # ever make sense is when all schemas from the array are of
+                # object type.
+                merged_schema = schema.copy()
+                for item in merged_schema.pop("allOf"):
+                    merged_schema = _merge_mappings(merged_schema, copy.deepcopy(item))
+                return merged_schema
+
+            elif "not" in schema:
+                # Eh.. do nothing because I have no idea what can we do.
+                return {}
+
+            return schema
+
+        def _traverse_schema(schema, name, is_required=False):
+            schema_type = _get_schema_type(schema)
+
+            if {"oneOf", "anyOf", "allOf"} & schema.keys():
+                # Since an item can represented by either or any schema from
+                # the array of schema in case of `oneOf` and `anyOf`
+                # respectively, the best we can do for them is to render the
+                # first found variant. In other words, we are going to traverse
+                # only a single schema variant and leave the rest out. This is
+                # by design and it was decided so in order to keep produced
+                # description clear and simple.
+                yield from _traverse_schema(_resolve_combining_schema(schema), name)
+
+            elif "not" in schema:
+                yield name, {}, is_required
+
+            elif schema_type == "object":
+                if name:
+                    yield name, schema, is_required
+
+                required = set(schema.get("required", []))
+
+                for key, value in schema.get("properties", {}).items():
+                    # In case of the first recursion call, when 'name' is an
+                    # empty string, we should go with 'key' only in order to
+                    # avoid leading dot at the beginning.
+                    yield from _traverse_schema(
+                        value,
+                        f"{name}.{key}" if name else key,
+                        is_required=key in required,
+                    )
+
+            elif schema_type == "array":
+                yield from _traverse_schema(schema["items"], f"{name}[]")
+
+            elif "enum" in schema:
+                yield name, schema, is_required
+
+            elif schema_type is not None:
+                yield name, schema, is_required
+
+        schema = _resolve_combining_schema(schema)
+        schema_type = _get_schema_type(schema)
+
+        # On root level, httpdomain supports only 'object' and 'array' response
+        # types. If it's something else, let's do not even try to render it.
+        if schema_type not in {"object", "array"}:
+            return
+
+        # According to httpdomain's documentation, 'reqjsonobj' is an alias for
+        # 'reqjson'. However, since the same name is passed as a type directive
+        # internally, it actually can be used to specify its type. The same
+        # goes for 'resjsonobj'.
+        directives_map = {
+            "req": {
+                "object": ("reqjson", "reqjsonobj"),
+                "array": ("reqjsonarr", "reqjsonarrtype"),
+            },
+            "res": {
+                "object": ("resjson", "resjsonobj"),
+                "array": ("resjsonarr", "resjsonarrtype"),
+            },
+        }
+
+        # These httpdomain's fields always expect either JSON Object or JSON
+        # Array. No primitive types are allowed as input.
+        directive, typedirective = directives_map[req_or_res][schema_type]
+
+        # Since we use JSON array specific httpdomain directives if a schema
+        # we're about to render is an array, there's no need to render that
+        # array in the first place.
+        if schema_type == "array":
+            schema = schema["items"]
+
+            # Even if a root element is an array, items it contain must not be
+            # of a primitive types.
+            if _get_schema_type(schema) not in {"object", "array"}:
+                return
+
+        for name, schema, is_required in _traverse_schema(schema, ""):
+            yield f":{directive} {name}:"
+
+            if schema.get("description"):
+                yield from indented(
+                    self._convert_markup(schema["description"]).strip().splitlines()
+                )
+
+            markers = _get_markers_from_object({}, schema)
+
+            if is_required:
+                markers.append("required")
+
+            if markers:
+                markers = ", ".join(markers)
+                yield f":{typedirective} {name}: {markers}"

tests/renderers/httpdomain/rendered/v2.0/petstore-expanded.yaml.rst

@@ -8,6 +8,7 @@
    :queryparam limit:
       maximum number of results to return
    :queryparamtype limit: integer:int32
+
    :statuscode 200:
       pet response
 
@@ -18,6 +19,18 @@
 
    Creates a new pet in the store.  Duplicates are allowed
 
+   :reqjson name:
+   :reqjsonobj name: string, required
+   :reqjson tag:
+   :reqjsonobj tag: string
+
+
+   :resjson name:
+   :resjsonobj name: string
+   :resjson tag:
+   :resjsonobj tag: string
+   :resjson id:
+   :resjsonobj id: integer:int64, required
 
    :statuscode 200:
       pet response
@@ -32,6 +45,13 @@
    :param id:
       ID of pet to fetch
    :paramtype id: integer:int64, required
+   :resjson name:
+   :resjsonobj name: string
+   :resjson tag:
+   :resjsonobj tag: string
+   :resjson id:
+   :resjsonobj id: integer:int64, required
+
    :statuscode 200:
       pet response
 

tests/renderers/httpdomain/rendered/v2.0/petstore.yaml.rst

@@ -5,6 +5,13 @@
    :queryparam limit:
       How many items to return at one time (max 100)
    :queryparamtype limit: integer:int32
+   :resjsonarr id:
+   :resjsonarrtype id: integer:int64, required
+   :resjsonarr name:
+   :resjsonarrtype name: string, required
+   :resjsonarr tag:
+   :resjsonarrtype tag: string
+
    :statuscode 200:
       A paged array of pets
 
@@ -31,6 +38,13 @@
    :param petId:
       The id of the pet to retrieve
    :paramtype petId: string, required
+   :resjsonarr id:
+   :resjsonarrtype id: integer:int64, required
+   :resjsonarr name:
+   :resjsonarrtype name: string, required
+   :resjsonarr tag:
+   :resjsonarrtype tag: string
+
    :statuscode 200:
       Expected response to a valid request