Add missing id, name fields to json schema docs

Added the optional id and name fields which are documented on the FINOS site but currently missing from OrderList, InstrumentList, ContactList and Contact (name only).
finos · Jun 27, 2024 · 13ccdd2 · 13ccdd2
1 parent dcd98c2
commit 13ccdd2
Show file tree

Hide file tree

Showing 4 changed files with 43 additions and 3 deletions.
diff --git a/schemas/context/contact.schema.json b/schemas/context/contact.schema.json
@@ -28,6 +28,10 @@
               "description": "FactSet Permanent Identifier representing the contact"
             }
           }
+        },
+        "name": {
+          "type": "string",
+          "description": "An optional human-readable name for the contact"
         }
       },
       "required": [

diff --git a/schemas/context/contactList.schema.json b/schemas/context/contactList.schema.json
@@ -11,6 +11,18 @@
         "type": {
           "const": "fdc3.contactList"
         },
+        "id": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "title": "Contact List Identifiers",
+          "description": "One or more identifiers that refer to the contact list in an OMS, EMS or related system. Specific key names for systems are expected to be standardized in future."
+        },
+        "name": {
+          "type": "string",
+          "description": "An optional human-readable summary of the contact list"
+        },
         "contacts": {
           "type": "array",
           "title": "List of Contacts",
@@ -47,4 +59,4 @@
       ]
     }
   ]
-}
+}
diff --git a/schemas/context/instrumentList.schema.json b/schemas/context/instrumentList.schema.json
@@ -11,6 +11,18 @@
         "type": {
           "const": "fdc3.instrumentList"
         },
+        "id": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "title": "Instrument List Identifiers",
+          "description": "One or more identifiers that refer to the instrument list in an OMS, EMS or related system. Specific key names for systems are expected to be standardized in future."
+        },
+        "name": {
+          "type": "string",
+          "description": "An optional human-readable summary of the  instrument list"
+        },
         "instruments": {
           "type": "array",
           "title": "List of instruments",
@@ -48,4 +60,4 @@
       ]
     }
   ]
-}
+}
diff --git a/schemas/context/orderList.schema.json b/schemas/context/orderList.schema.json
@@ -11,6 +11,18 @@
         "type": {
           "const": "fdc3.orderList"
         },
+        "id": {
+          "type": "object",
+          "additionalProperties": {
+            "type": "string"
+          },
+          "title": "Order List Identifiers",
+          "description": "One or more identifiers that refer to the order list in an OMS, EMS or related system. Specific key names for systems are expected to be standardized in future."
+        },
+        "name": {
+          "type": "string",
+          "description": "An optional human-readable summary of the order list"
+        },
         "orders": {
           "type": "array",
           "items": {
@@ -46,4 +58,4 @@
       ]
     }
   ]
-}
+}