Add schema standard version to Libdoc JSON schema.

Decided to go with Draft 2020-12 which is currently the latest version.
robotframework · Apr 27, 2022 · c43fb46 · c43fb46
1 parent 804c8c9
commit c43fb46
Show file tree

Hide file tree

Showing 2 changed files with 8 additions and 0 deletions.
diff --git a/doc/schema/libdoc.json b/doc/schema/libdoc.json
@@ -89,6 +89,7 @@
     "keywords",
     "typedocs"
   ],
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
   "definitions": {
     "DocumentationType": {
       "title": "DocumentationType",

diff --git a/doc/schema/libdoc_json_schema.py b/doc/schema/libdoc_json_schema.py
@@ -121,6 +121,13 @@ class Libdoc(BaseModel):
     dataTypes: dict = Field({}, description="Deprecated. Use 'typedocs' instead.")
     typedocs: List[TypeDoc]
 
+    # pydantic doesn't add schema version automatically.
+    # https://github.com/samuelcolvin/pydantic/issues/1478
+    class Config:
+        schema_extra = {
+            '$schema': 'https://json-schema.org/draft/2020-12/schema'
+        }
+
 
 if __name__ == '__main__':
     path = Path(__file__).parent / 'libdoc.json'