Skip to content

Commit e4e2024

Browse files
committed
fixup: remove type suggestions from generic name field
1 parent 17f846d commit e4e2024

File tree

3 files changed

+6
-18
lines changed

3 files changed

+6
-18
lines changed

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

Lines changed: 4 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -285,14 +285,8 @@ export interface OrganizationClassification {
285285
*/
286286
FDS_TYPE?: FactSetType;
287287
/**
288-
* classification of the instrument by type or category. SHOULD be one of the following
289-
* values, although other string values are permitted: '`commodity`', '`commodityIndex`',
290-
* '`corporateDebt`', '`creditDefaultSwapIndex`', '`deal`', '`debt`', '`debtIndex`',
291-
* '`etf`', '`fixedIncome`', '`future`', '`governmentBenchmarkDebt`', '`loan`',
292-
* '`mortgageBackedSecurity`', '`municipalDebt`', '`mutualFund`', '`mutualFundIndex`',
293-
* '`option`', '`otherDebt`', '`ownershipPrivateCompany`', '`pevcFirm`', '`pevcFund`',
294-
* '`privateCompany`', '`publicCompany`', '`publicCompanyIndex`', '`sovereignDebt`',
295-
* '`structuredProduct`', '`unknown`'
288+
* Optional human-readable classification, to be used if no specific data classification is
289+
* available.
296290
*/
297291
name?: string;
298292
[property: string]: any;
@@ -1260,14 +1254,8 @@ export interface PurpleInstrumentClassification {
12601254
*/
12611255
FDS_TYPE?: FactSetType;
12621256
/**
1263-
* classification of the instrument by type or category. SHOULD be one of the following
1264-
* values, although other string values are permitted: '`commodity`', '`commodityIndex`',
1265-
* '`corporateDebt`', '`creditDefaultSwapIndex`', '`deal`', '`debt`', '`debtIndex`',
1266-
* '`etf`', '`fixedIncome`', '`future`', '`governmentBenchmarkDebt`', '`loan`',
1267-
* '`mortgageBackedSecurity`', '`municipalDebt`', '`mutualFund`', '`mutualFundIndex`',
1268-
* '`option`', '`otherDebt`', '`ownershipPrivateCompany`', '`pevcFirm`', '`pevcFund`',
1269-
* '`privateCompany`', '`publicCompany`', '`publicCompanyIndex`', '`sovereignDebt`',
1270-
* '`structuredProduct`', '`unknown`'
1257+
* Optional human-readable classification, to be used if no specific data classification is
1258+
* available.
12711259
*/
12721260
name?: string;
12731261
[property: string]: any;

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@
105105
"name": {
106106
"type": "string",
107107
"title": "FDC3 Instrument Classification Name",
108-
"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`'"
108+
"description": "Optional human-readable classification, to be used if no specific data classification is available."
109109
},
110110
"FDS_TYPE": {
111111
"title": "FactSet Type",

website/docs/context/ref/Instrument.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ The `market` map can be used to further specify the instrument and help achieve
183183

184184
**type**: `string`
185185

186-
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`'
186+
Optional human-readable classification, to be used if no specific data classification is available.
187187

188188
</details>
189189

0 commit comments

Comments
 (0)