refactor: change classification.fdc3 to classification.name

Author: hughtroeger

packages/fdc3-context/generated/context/ContextTypes.ts

@@ -280,6 +280,10 @@ export interface InstrumentElement {
  * instrument and help achieve interoperability between disparate data sources.
  */
 export interface OrganizationClassification {
+  /**
+   * FactSet classification for the instrument.
+   */
+  FDS_TYPE?: string;
   /**
    * classification of the instrument by type or category. SHOULD be one of the following
    * values, although other string values are permitted: '`commodity`', '`commodityIndex`',
@@ -290,11 +294,7 @@ export interface OrganizationClassification {
    * '`privateCompany`', '`publicCompany`', '`publicCompanyIndex`', '`sovereignDebt`',
    * '`structuredProduct`', '`unknown`'
    */
-  fdc3?: string;
-  /**
-   * FactSet classification for the instrument.
-   */
-  FDS_TYPE?: string;
+  name?: string;
   [property: string]: any;
 }
 
@@ -1223,6 +1223,10 @@ export interface Instrument {
  * instrument and help achieve interoperability between disparate data sources.
  */
 export interface PurpleInstrumentClassification {
+  /**
+   * FactSet classification for the instrument.
+   */
+  FDS_TYPE?: string;
   /**
    * classification of the instrument by type or category. SHOULD be one of the following
    * values, although other string values are permitted: '`commodity`', '`commodityIndex`',
@@ -1233,11 +1237,7 @@ export interface PurpleInstrumentClassification {
    * '`privateCompany`', '`publicCompany`', '`publicCompanyIndex`', '`sovereignDebt`',
    * '`structuredProduct`', '`unknown`'
    */
-  fdc3?: string;
-  /**
-   * FactSet classification for the instrument.
-   */
-  FDS_TYPE?: string;
+  name?: string;
   [property: string]: any;
 }
 
@@ -2464,8 +2464,8 @@ const typeMap: any = {
   ),
   OrganizationClassification: o(
     [
-      { json: 'fdc3', js: 'fdc3', typ: u(undefined, '') },
       { json: 'FDS_TYPE', js: 'FDS_TYPE', typ: u(undefined, '') },
+      { json: 'name', js: 'name', typ: u(undefined, '') },
     ],
     'any'
   ),
@@ -2765,8 +2765,8 @@ const typeMap: any = {
   ),
   PurpleInstrumentClassification: o(
     [
-      { json: 'fdc3', js: 'fdc3', typ: u(undefined, '') },
       { json: 'FDS_TYPE', js: 'FDS_TYPE', typ: u(undefined, '') },
+      { json: 'name', js: 'name', typ: u(undefined, '') },
     ],
     'any'
   ),

packages/fdc3-context/schemas/context/instrument.schema.json

@@ -102,7 +102,7 @@
           "description": "@experimental The `classification` map can be used to specify the categorization of the instrument and help achieve interoperability between disparate data sources.",
           "type": "object",
           "properties": {
-            "fdc3": {
+            "name": {
               "type": "string",
               "title": "FDC3 Instrument Classification Name",
               "description": "classification of the instrument by type or category. SHOULD be one of the following values, although other string values are permitted: '`commodity`', '`commodityIndex`', '`corporateDebt`', '`creditDefaultSwapIndex`', '`deal`', '`debt`', '`debtIndex`', '`etf`', '`fixedIncome`', '`future`', '`governmentBenchmarkDebt`', '`loan`', '`mortgageBackedSecurity`', '`municipalDebt`', '`mutualFund`', '`mutualFundIndex`', '`option`', '`otherDebt`', '`ownershipPrivateCompany`', '`pevcFirm`', '`pevcFund`', '`privateCompany`', '`publicCompany`', '`publicCompanyIndex`', '`sovereignDebt`', '`structuredProduct`', '`unknown`'"
@@ -134,7 +134,7 @@
           "MIC": "XNAS"
       },
       "classification": {
-          "fdc3": "publicCompany"
+          "name": "publicCompany"
       }
     }
   ]

website/docs/context/ref/Instrument.md

@@ -179,7 +179,7 @@ The `market` map can be used to further specify the instrument and help achieve
 **Subproperties:**
 
 <details>
-  <summary><code>fdc3</code></summary>
+  <summary><code>name</code></summary>
 
 **type**: `string`
 
@@ -215,7 +215,7 @@ FactSet classification for the instrument.
     "MIC": "XNAS"
   },
   "classification": {
-    "fdc3": "publicCompany"
+    "name": "publicCompany"
   }
 }
 ```