From ffa3b095c6630cb0a6c160b30054faeb8ab552e0 Mon Sep 17 00:00:00 2001
From: Jim Madge <jmadge@turing.ac.uk>
Date: Thu, 5 Oct 2023 16:10:22 +0100
Subject: [PATCH] Correct description of schemas

---
 README.md | 20 ++++++++++++--------
 1 file changed, 12 insertions(+), 8 deletions(-)

diff --git a/README.md b/README.md
index 14c9224..296910b 100644
--- a/README.md
+++ b/README.md
@@ -22,10 +22,13 @@ We recognise the following major repositories and organisations may create `<rep
 ### Package list schema
 
 Package lists are formatted as JSON.
-Each file is a list of package entries with the following fields.
+The schema for major repositories is formally described in [`schema.json`](./schema.json).
+This is a [JSON Schema](https://json-schema.org/overview/what-is-jsonschema) document using the 2020-12 draft.
+
+In brief, each file is a list of package entries with the following fields.
 
 - `package_name` (text, case sensitive, uniquely defines a package for a repository)
-- `version` (text, [PEP440 style](https://peps.python.org/pep-0440/#version-specifiers))
+- `version` (text, comparison operator plus [PEP440 style](https://peps.python.org/pep-0440/#version-specifiers) version number)
 - `approval_date` (ISO 8601)
 - `revoke_date` (ISO 8601 or `null` if not revoked)
 
@@ -33,13 +36,14 @@ For example,
 
 ```JSON
 [
-    {
-        "package_name": "numpy",
-        "version": "*",
-        "approval_date": "2023-09-29",
-        "revoke_date": null
-    }
+  {
+    "package_name": "numpy",
+    "version": "== 1.2.3",
+    "approval_date": "2023-09-29",
+    "revoke_date": null
+  }
 ]
 ```
 
 Additionally for packages not in a major repository, _i.e._ those in `other.json`, a `url` field is added to uniquely identify the package and give its source.
+The other schema is described in [`schema_other.json`](schema_other.json).