diff --git a/package.json b/package.json index b9607dc..02222a4 100644 --- a/package.json +++ b/package.json @@ -9,7 +9,7 @@ "scripts": { "test": "NODE_ENV=test jest --config config/jest.config.js --detectOpenHandles --forceExit", "jsdoc": "jsdoc -r src -R README.md -d jsdoc -c config/jsdoc.config.js", - "lint": "eslint src test --config .eslintrc.json --ext .ts,.tsx --quiet", + "lint": "eslint src --config .eslintrc.json --ext .ts,.tsx --quiet", "build": "tsc", "prepublishOnly": "npm ci && npm run build" }, diff --git a/src/definitions/variant.ts b/src/definitions/variant.ts index ca1cb87..503413b 100644 --- a/src/definitions/variant.ts +++ b/src/definitions/variant.ts @@ -116,9 +116,14 @@ const models: PartialSchemaDefn = { type: 'string', pattern: '^(hg\\d+)|(grch\\d+)$', description: 'Flag which is optionally used for genomic variants that are not linked to a fixed assembly reference', + deprecated: true, }, { - name: 'hgvsType', type: 'string', examples: ['delins'], description: 'the short form of this type to use in building an HGVS-like representation', + name: 'hgvsType', + type: 'string', + examples: ['delins'], + description: 'the short form of this type to use in building an HGVS-like representation', + deprecated: true, }, ], indices: [ diff --git a/src/types.ts b/src/types.ts index c5b8583..2aa1c31 100644 --- a/src/types.ts +++ b/src/types.ts @@ -120,6 +120,8 @@ export interface PropertyDefinition { /** enum representing acceptable values */ choices?: unknown[]; default?: unknown; + /** flag property as deprecated yet not removed, so the client should not show it */ + deprecated?: boolean; /** description for the openapi spec */ description?: string; /** example values to use for help text */