fix: Fix JSON schema for ending line numbers (and add test)

docs/schema.json

@@ -1,5 +1,5 @@
 {
-  "$schema": "https://json-schema.org/draft-07/schema",
+  "$schema": "http://json-schema.org/draft-07/schema",
   "title": "Griffe object.",
   "oneOf": [
     {
@@ -26,9 +26,17 @@
           "type": "string"
         },
         "lineno": {
-          "title": "For aliases, the line number in their own module.",
+          "title": "For aliases, the import starting line number in their own module.",
           "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Alias.lineno",
           "type": "integer"
+        },
+        "endlineno": {
+          "title": "For aliases, the import ending line number in their own module.",
+          "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Alias.endlineno",
+          "type": [
+            "integer",
+            "null"
+          ]
         }
       },
       "additionalProperties": false,
@@ -101,7 +109,10 @@
             "endlineno": {
               "title": "The docstring ending line number.",
               "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Docstring.endlineno",
-              "type": "integer"
+              "type": [
+                "integer",
+                "null"
+              ]
             },
             "parsed": {
               "title": "The parsed docstring (list of docstring sections).",
@@ -162,7 +173,10 @@
         "endlineno": {
           "title": "The docstring ending line number.",
           "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Docstring.endlineno",
-          "type": "integer"
+          "type": [
+            "integer",
+            "null"
+          ]
         },
         "bases": true,
         "decorators": true,
@@ -221,7 +235,10 @@
                     "endlineno": {
                       "title": "The decorator ending line number.",
                       "markdownDescription": "https://mkdocstrings.github.io/griffe/reference/griffe/dataclasses/#griffe.dataclasses.Decorator.endlineno",
-                      "type": "integer"
+                      "type": [
+                        "integer",
+                        "null"
+                      ]
                     }
                   },
                   "additionalProperties": false,

pyproject.toml

@@ -90,6 +90,7 @@ tests = [
     "pytest-randomly>=3.10",
     "pytest-xdist>=2.4",
     "hypothesmith>=0.2.0",
+    "jsonschema>=4.17.3",
 ]
 typing = [
     "mypy>=0.910",

tests/test_encoders.py

@@ -2,7 +2,10 @@
 
 from __future__ import annotations
 
+import json
+
 import pytest
+from jsonschema import ValidationError, validate
 
 from griffe.dataclasses import Function, Module, Object
 from griffe.loader import GriffeLoader
@@ -30,3 +33,27 @@ def test_minimal_data_is_enough() -> None:
     with pytest.raises(TypeError) as err:
         Function.from_json(minimal)
     assert "provided JSON object is not of type" in str(err.value)
+
+
+# use this function in test_json_schema to ease schema debugging
+def _validate(obj: dict, schema: dict):
+    if "members" in obj:
+        for member in obj["members"]:
+            _validate(member, schema)
+
+    try:
+        validate(obj, schema)
+    except ValidationError:
+        print(obj["path"])
+        raise
+
+
+def test_json_schema() -> None:
+    """Assert that our serialized data matches our JSON schema."""
+    loader = GriffeLoader()
+    module = loader.load_module("griffe")
+    loader.resolve_aliases()
+    data = json.loads(module.as_json(full=True))
+    with open("docs/schema.json") as f:
+        schema = json.load(f)
+    validate(data, schema)