Make version schema more strict

truenas · May 15, 2024 · 1e30270 · 1e30270
1 parent d830c7e
commit 1e30270
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 2 deletions.
diff --git a/apps_validation/json_schema_utils.py b/apps_validation/json_schema_utils.py
@@ -285,6 +285,8 @@
                     'pattern': '[0-9]+.[0-9]+.[0-9]+'
                 },
                 'app_metadata': APP_METADATA_JSON_SCHEMA,
+                'readme': {'type': ['string', 'null']},
+                'changelog': {'type': ['string', 'null']},
                 'schema': {
                     'type': 'object',
                     'properties': {
@@ -330,7 +332,7 @@
             },
             'required': [
                 'healthy', 'supported', 'healthy_error', 'location', 'last_update', 'required_features',
-                'human_version', 'version', 'app_metadata', 'schema',
+                'human_version', 'version', 'app_metadata', 'schema', 'readme', 'changelog',
             ],
         },
     },

diff --git a/catalog_reader/app.py b/catalog_reader/app.py
@@ -149,7 +149,7 @@ def get_app_version_details(
     for key, filename, parser in (
         ('app_metadata', 'app.yaml', yaml.safe_load),
         ('schema', 'questions.yaml', yaml.safe_load),
-        ('readme', 'README.md', markdown.markdown),  # TODO: Has been changed, make sure json schema accounts for it
+        ('readme', 'README.md', markdown.markdown),
         ('changelog', 'CHANGELOG.md', markdown.markdown),
     ):
         if os.path.exists(os.path.join(version_path, filename)):