components:
schemas:
AcmgRank-Input:
properties:
comment:
title: Comment
type: string
criterias:
items:
$ref: '#/components/schemas/SeqVarCriteria'
title: Criterias
type: array
required:
- criterias
- comment
title: AcmgRank
type: object
AcmgRank-Output:
properties:
comment:
title: Comment
type: string
criterias:
items:
$ref: '#/components/schemas/SeqVarCriteria'
title: Criterias
type: array
required:
- criterias
- comment
title: AcmgRank
type: object
AcmgSeqVarCreate-Input:
properties:
acmg_rank:
$ref: '#/components/schemas/AcmgRank-Input'
seqvar_name:
minLength: 1
pattern: ^(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-([CGAT]+)-([CGAT]+)$
title: Seqvar Name
type: string
user:
anyOf:
- format: uuid
type: string
- type: 'null'
title: User
required:
- seqvar_name
- acmg_rank
title: AcmgSeqVarCreate
type: object
AcmgSeqVarCreate-Output:
properties:
acmg_rank:
$ref: '#/components/schemas/AcmgRank-Output'
seqvar_name:
minLength: 1
pattern: ^(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-([CGAT]+)-([CGAT]+)$
title: Seqvar Name
type: string
user:
anyOf:
- format: uuid
type: string
- type: 'null'
title: User
required:
- seqvar_name
- acmg_rank
title: AcmgSeqVarCreate
type: object
AcmgSeqVarRead:
properties:
acmg_rank:
$ref: '#/components/schemas/AcmgRank-Output'
id:
format: uuid
title: Id
type: string
seqvar_name:
minLength: 1
pattern: ^(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-([CGAT]+)-([CGAT]+)$
title: Seqvar Name
type: string
user:
anyOf:
- format: uuid
type: string
- type: 'null'
title: User
required:
- seqvar_name
- acmg_rank
- id
title: AcmgSeqVarRead
type: object
AcmgSeqVarUpdate:
properties:
acmg_rank:
$ref: '#/components/schemas/AcmgRank-Input'
seqvar_name:
minLength: 1
pattern: ^(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-([CGAT]+)-([CGAT]+)$
title: Seqvar Name
type: string
user:
anyOf:
- format: uuid
type: string
- type: 'null'
title: User
required:
- seqvar_name
- acmg_rank
title: AcmgSeqVarUpdate
type: object
AdminMessageRead:
properties:
active_start:
anyOf:
- format: date-time
type: string
- type: 'null'
title: Active Start
active_stop:
anyOf:
- format: date-time
type: string
- type: 'null'
title: Active Stop
enabled:
anyOf:
- type: boolean
- type: 'null'
title: Enabled
id:
format: uuid
title: Id
type: string
text:
anyOf:
- type: string
- type: 'null'
title: Text
title:
anyOf:
- type: string
- type: 'null'
title: Title
required:
- id
title: AdminMessageRead
type: object
AffectedStatus:
enum:
- 'yes'
- 'no'
- unknown
- not provided
- not applicable
title: AffectedStatus
type: string
AlleleOrigin:
enum:
- germline
- somatic
- de novo
- unknown
- inherited
- maternal
- paternal
- biparental
- not applicable
title: AlleleOrigin
type: string
Assembly:
enum:
- GRCh38
- hg38
- GRCh37
- hg19
- NCBI36
- hg18
title: Assembly
type: string
BatchProcessingStatus:
enum:
- In processing
- Success
- Error
- Partial success
title: BatchProcessingStatus
type: string
BatchReleaseStatus:
enum:
- Released
- Partial released
- Not released
title: BatchReleaseStatus
type: string
BearerResponse:
properties:
access_token:
title: Access Token
type: string
token_type:
title: Token Type
type: string
required:
- access_token
- token_type
title: BearerResponse
type: object
Body_auth_bearer_login_api_v1_auth_bearer_login_post:
properties:
client_id:
anyOf:
- type: string
- type: 'null'
title: Client Id
client_secret:
anyOf:
- type: string
- type: 'null'
title: Client Secret
grant_type:
anyOf:
- pattern: password
type: string
- type: 'null'
title: Grant Type
password:
title: Password
type: string
scope:
default: ''
title: Scope
type: string
username:
title: Username
type: string
required:
- username
- password
title: Body_auth_bearer_login_api_v1_auth_bearer_login_post
type: object
Body_auth_cookie_login_api_v1_auth_cookie_login_post:
properties:
client_id:
anyOf:
- type: string
- type: 'null'
title: Client Id
client_secret:
anyOf:
- type: string
- type: 'null'
title: Client Secret
grant_type:
anyOf:
- pattern: password
type: string
- type: 'null'
title: Grant Type
password:
title: Password
type: string
scope:
default: ''
title: Scope
type: string
username:
title: Username
type: string
required:
- username
- password
title: Body_auth_cookie_login_api_v1_auth_cookie_login_post
type: object
Body_verify_request_token_api_v1_auth_request_verify_token_post:
properties:
email:
format: email
title: Email
type: string
required:
- email
title: Body_verify_request_token_api_v1_auth_request_verify_token_post
type: object
Body_verify_verify_api_v1_auth_verify_post:
properties:
token:
title: Token
type: string
required:
- token
title: Body_verify_verify_api_v1_auth_verify_post
type: object
BookmarkCreate:
properties:
obj_id:
minLength: 1
pattern: ^(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-([CGAT]+)-([CGAT]+)$|^(DEL|DUP)-(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-(\d+)$|^HGNC:(\d+)$
title: Obj Id
type: string
obj_type:
$ref: '#/components/schemas/BookmarkTypes'
user:
anyOf:
- format: uuid
type: string
- type: 'null'
title: User
required:
- obj_type
- obj_id
title: BookmarkCreate
type: object
BookmarkRead:
properties:
id:
format: uuid
title: Id
type: string
obj_id:
minLength: 1
pattern: ^(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-([CGAT]+)-([CGAT]+)$|^(DEL|DUP)-(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-(\d+)$|^HGNC:(\d+)$
title: Obj Id
type: string
obj_type:
$ref: '#/components/schemas/BookmarkTypes'
user:
anyOf:
- format: uuid
type: string
- type: 'null'
title: User
required:
- obj_type
- obj_id
- id
title: BookmarkRead
type: object
BookmarkTypes:
enum:
- seqvar
- strucvar
- gene
title: BookmarkTypes
type: string
CaseInfoCreate:
properties:
affected_family_members:
anyOf:
- type: boolean
- type: 'null'
title: Affected Family Members
age_of_onset_month:
anyOf:
- type: integer
- type: 'null'
title: Age Of Onset Month
diseases:
anyOf:
- items:
$ref: '#/components/schemas/DiseaseTerm'
type: array
- type: 'null'
title: Diseases
ethnicity:
$ref: '#/components/schemas/Ethnicity'
default: reev:unknown_ethnicity
family_segregation:
anyOf:
- type: boolean
- type: 'null'
title: Family Segregation
hpo_terms:
anyOf:
- items:
$ref: '#/components/schemas/HpoTerm'
type: array
- type: 'null'
title: Hpo Terms
inheritance:
$ref: '#/components/schemas/Inheritance'
default: reev:unknown_inheritance
pseudonym:
anyOf:
- type: string
- type: 'null'
title: Pseudonym
sex:
$ref: '#/components/schemas/Sex'
default: reev:unknown_sex
user:
anyOf:
- format: uuid
type: string
- type: 'null'
title: User
zygosity:
$ref: '#/components/schemas/Zygosity'
default: reev:unknown_zygosity
title: CaseInfoCreate
type: object
CaseInfoRead:
properties:
affected_family_members:
anyOf:
- type: boolean
- type: 'null'
title: Affected Family Members
age_of_onset_month:
anyOf:
- type: integer
- type: 'null'
title: Age Of Onset Month
diseases:
anyOf:
- items:
$ref: '#/components/schemas/DiseaseTerm'
type: array
- type: 'null'
title: Diseases
ethnicity:
$ref: '#/components/schemas/Ethnicity'
default: reev:unknown_ethnicity
family_segregation:
anyOf:
- type: boolean
- type: 'null'
title: Family Segregation
hpo_terms:
anyOf:
- items:
$ref: '#/components/schemas/HpoTerm'
type: array
- type: 'null'
title: Hpo Terms
id:
format: uuid
title: Id
type: string
inheritance:
$ref: '#/components/schemas/Inheritance'
default: reev:unknown_inheritance
pseudonym:
anyOf:
- type: string
- type: 'null'
title: Pseudonym
sex:
$ref: '#/components/schemas/Sex'
default: reev:unknown_sex
user:
anyOf:
- format: uuid
type: string
- type: 'null'
title: User
zygosity:
$ref: '#/components/schemas/Zygosity'
default: reev:unknown_zygosity
required:
- id
title: CaseInfoRead
type: object
CaseInfoUpdate:
properties:
affected_family_members:
anyOf:
- type: boolean
- type: 'null'
title: Affected Family Members
age_of_onset_month:
anyOf:
- type: integer
- type: 'null'
title: Age Of Onset Month
diseases:
anyOf:
- items:
$ref: '#/components/schemas/DiseaseTerm'
type: array
- type: 'null'
title: Diseases
ethnicity:
$ref: '#/components/schemas/Ethnicity'
default: reev:unknown_ethnicity
family_segregation:
anyOf:
- type: boolean
- type: 'null'
title: Family Segregation
hpo_terms:
anyOf:
- items:
$ref: '#/components/schemas/HpoTerm'
type: array
- type: 'null'
title: Hpo Terms
inheritance:
$ref: '#/components/schemas/Inheritance'
default: reev:unknown_inheritance
pseudonym:
anyOf:
- type: string
- type: 'null'
title: Pseudonym
sex:
$ref: '#/components/schemas/Sex'
default: reev:unknown_sex
user:
anyOf:
- format: uuid
type: string
- type: 'null'
title: User
zygosity:
$ref: '#/components/schemas/Zygosity'
default: reev:unknown_zygosity
title: CaseInfoUpdate
type: object
Chromosome:
enum:
- '1'
- '2'
- '3'
- '4'
- '5'
- '6'
- '7'
- '8'
- '9'
- '10'
- '11'
- '12'
- '13'
- '14'
- '15'
- '16'
- '17'
- '18'
- '19'
- '20'
- '21'
- '22'
- X
- Y
- MT
title: Chromosome
type: string
CitationDb:
description: 'Allowed values for a citation''s `db` field.
The values of the enumeration map to the values used by the ClinVar submission
API.'
enum:
- PubMed
- BookShelf
- DOI
- pmc
title: CitationDb
type: string
ClinicalFeaturesAffectedStatus:
enum:
- present
- absent
- not tested
title: ClinicalFeaturesAffectedStatus
type: string
ClinicalFeaturesDb:
const: HP
enum:
- HP
title: ClinicalFeaturesDb
type: string
ClinicalSignificanceDescription:
description: 'Allowed values for the ``clinicalSignificanceDescription`` and
``germlineClassificationDescription``.
The values of the enumeration map to the values used by the ClinVar submission
API.'
enum:
- Pathogenic
- Likely pathogenic
- Uncertain significance
- Likely benign
- Benign
- Pathogenic, low penetrance
- Uncertain risk allele
- Likely pathogenic, low penetrance
- Established risk allele
- Likely risk allele
- affects
- association
- drug response
- confers sensitivity
- protective
- other
- not provided
title: ClinicalSignificanceDescription
type: string
CollectionMethod:
enum:
- curation
- literature only
- reference population
- provider interpretation
- phenotyping only
- case-control
- clinical testing
- in vitro
- in vivo
- research
- not provided
title: CollectionMethod
type: string
ConditionDb:
enum:
- OMIM
- MedGen
- Orphanet
- MeSH
- HP
- MONDO
title: ConditionDb
type: string
Created:
properties:
id:
title: Id
type: string
required:
- id
title: Created
type: object
Criteria:
enum:
- PVS1
- PS1
- PS2
- PS3
- PS4
- PM1
- PM2
- PM3
- PM4
- PM5
- PM6
- PP1
- PP2
- PP3
- PP4
- BA1
- BS1
- BS2
- BS3
- BS4
- BP1
- BP2
- BP3
- BP4
- BP5
- BP7
title: Criteria
type: string
DiseaseTerm:
properties:
name:
title: Name
type: string
omimId:
title: Omimid
type: string
required:
- omimId
- name
title: DiseaseTerm
type: object
ErrorCode:
enum:
- '0'
- '1'
- '2'
title: ErrorCode
type: string
ErrorModel:
properties:
detail:
anyOf:
- type: string
- additionalProperties:
type: string
type: object
title: Detail
required:
- detail
title: ErrorModel
type: object
Ethnicity:
enum:
- NCIT:C128937
- NCIT:C17950
- NCIT:C161419
- NCIT:C43865
- NCIT:C43851
- NCIT:C17459
- NCIT:C43866
- NCIT:C41263
- NCIT:C104495
- reev:unknown_ethnicity
title: Ethnicity
type: string
Evidence:
enum:
- Pathogenic Very Strong
- Pathogenic Strong
- Pathogenic Moderate
- Pathogenic Supporting
- Benign Standalone
- Benign Strong
- Benign Supporting
- Not Set
title: Evidence
type: string
GermlineClassification-Input:
description: Details of somatic clinical impact classification.
properties:
citation:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCitation'
type: array
- type: 'null'
title: Citation
comment:
anyOf:
- type: string
- type: 'null'
title: Comment
custom_classification_score:
anyOf:
- type: number
- type: 'null'
title: Custom Classification Score
date_last_evaluated:
anyOf:
- type: string
- type: 'null'
title: Date Last Evaluated
explanation_of_drug_response:
anyOf:
- type: string
- type: 'null'
title: Explanation Of Drug Response
explanation_of_other_classification:
anyOf:
- type: string
- type: 'null'
title: Explanation Of Other Classification
germline_classification_description:
$ref: '#/components/schemas/ClinicalSignificanceDescription'
mode_of_inheritance:
$ref: '#/components/schemas/ModeOfInheritance'
required:
- germline_classification_description
- mode_of_inheritance
title: GermlineClassification
type: object
GermlineClassification-Output:
description: Details of somatic clinical impact classification.
properties:
citation:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCitation'
type: array
- type: 'null'
title: Citation
comment:
anyOf:
- type: string
- type: 'null'
title: Comment
custom_classification_score:
anyOf:
- type: number
- type: 'null'
title: Custom Classification Score
date_last_evaluated:
anyOf:
- type: string
- type: 'null'
title: Date Last Evaluated
explanation_of_drug_response:
anyOf:
- type: string
- type: 'null'
title: Explanation Of Drug Response
explanation_of_other_classification:
anyOf:
- type: string
- type: 'null'
title: Explanation Of Other Classification
germline_classification_description:
$ref: '#/components/schemas/ClinicalSignificanceDescription'
mode_of_inheritance:
$ref: '#/components/schemas/ModeOfInheritance'
required:
- germline_classification_description
- mode_of_inheritance
title: GermlineClassification
type: object
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
title: Detail
type: array
title: HTTPValidationError
type: object
HpoTerm:
properties:
name:
title: Name
type: string
termId:
title: Termid
type: string
required:
- termId
- name
title: HpoTerm
type: object
Inheritance:
enum:
- NCIT:C94245
- NCIT:C94246
- NCIT:C94599
- NCIT:C93189
- NCIT:C94542
- NCIT:C94247
- reev:unknown_inheritance
title: Inheritance
type: string
ModeOfInheritance:
enum:
- Autosomal dominant inheritance
- Autosomal recessive inheritance
- Mitochondrial inheritance
- Genetic anticipation
- Sporadic
- Sex-limited autosomal dominant
- Somatic mutation
- X-linked recessive inheritance
- X-linked dominant inheritance
- Y-linked inheritance
- Other
- X-linked inheritance
- Codominant
- Semidominant inheritance
- Autosomal unknown
- Autosomal dominant inheritance with maternal imprinting
- Autosomal dominant inheritance with paternal imprinting
- Multifactorial inheritance
- Unknown mechanism
- Oligogenic inheritance
title: ModeOfInheritance
type: string
Msg:
properties:
msg:
title: Msg
type: string
required:
- msg
title: Msg
type: object
MultipleConditionExplanation:
enum:
- Novel disease
- Uncertain
- Co-occurring
title: MultipleConditionExplanation
type: string
OAuth2ProviderPublic:
description: Information exposed via API.
properties:
label:
title: Label
type: string
name:
title: Name
type: string
required:
- name
- label
title: OAuth2ProviderPublic
type: object
OncogenicityClassificationDescription:
enum:
- Oncogenic
- Likely Oncogenic
- - Uncertain significance
- - Likely benign
- Benign
title: OncogenicityClassificationDescription
Presence:
enum:
- Present
- Absent
- Unknown
title: Presence
type: string
PresenceOfSomaticVariantInNormalTissue:
enum:
- present
- absent
- not tested
title: PresenceOfSomaticVariantInNormalTissue
type: string
PublicOAuthAccount:
description: Public part of OAuth account model.
properties:
account_email:
title: Account Email
type: string
account_id:
title: Account Id
type: string
id:
title: Id
oauth_name:
title: Oauth Name
type: string
required:
- id
- oauth_name
- account_id
- account_email
title: PublicOAuthAccount
type: object
RecordStatus:
enum:
- novel
- update
title: RecordStatus
type: string
ReleaseStatus:
enum:
- public
- hold until published
title: ReleaseStatus
type: string
ResponseMessage:
description: 'A simple response message from ClinVar.
This is used for storing the error messages from ClinVar.'
properties:
text:
title: Text
type: string
required:
- text
title: ResponseMessage
type: object
RetrieveStatusResult-Input:
description: Result type for ``retrieve_status`` function.
properties:
status:
$ref: '#/components/schemas/SubmissionStatus-Input'
summaries:
additionalProperties:
$ref: '#/components/schemas/SummaryResponse-Input'
title: Summaries
type: object
required:
- status
- summaries
title: RetrieveStatusResult
type: object
RetrieveStatusResult-Output:
description: Result type for ``retrieve_status`` function.
properties:
status:
$ref: '#/components/schemas/SubmissionStatus-Output'
summaries:
additionalProperties:
$ref: '#/components/schemas/SummaryResponse-Output'
title: Summaries
type: object
required:
- status
- summaries
title: RetrieveStatusResult
type: object
SeqVarCriteria:
properties:
criteria:
$ref: '#/components/schemas/Criteria'
evidence:
$ref: '#/components/schemas/Evidence'
presence:
$ref: '#/components/schemas/Presence'
summary:
anyOf:
- type: string
- type: 'null'
title: Summary
required:
- criteria
- presence
- evidence
title: SeqVarCriteria
type: object
Sex:
enum:
- PATO:0000384
- PATO:0000383
- reev:unknown_sex
title: Sex
type: string
SomaticClinicalImpactAssertionType:
enum:
- 'therapeutic: sensitivity/response'
- 'therapeutic: resistance'
- 'therapeutic: reduced sensitivity'
- 'diagnostic: supports diagnosis'
- 'diagnostic: excludes diagnosis'
- 'prognostic: better outcome'
- 'prognostic: poor outcome'
title: SomaticClinicalImpactAssertionType
type: string
SomaticClinicalImpactClassification-Input:
description: Details of somatic clinical impact classification.
properties:
assertion_type_for_clinical_impact:
anyOf:
- $ref: '#/components/schemas/SomaticClinicalImpactAssertionType'
- type: 'null'
citation:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCitation'
type: array
- type: 'null'
title: Citation
clinical_impact_classification_description:
$ref: '#/components/schemas/SomaticClinicalImpactClassificationDescription'
comment:
anyOf:
- type: string
- type: 'null'
title: Comment
date_last_evaluated:
anyOf:
- type: string
- type: 'null'
title: Date Last Evaluated
drug_for_therapeutic_assertion:
anyOf:
- type: string
- type: 'null'
title: Drug For Therapeutic Assertion
required:
- clinical_impact_classification_description
title: SomaticClinicalImpactClassification
type: object
SomaticClinicalImpactClassification-Output:
description: Details of somatic clinical impact classification.
properties:
assertion_type_for_clinical_impact:
anyOf:
- $ref: '#/components/schemas/SomaticClinicalImpactAssertionType'
- type: 'null'
citation:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCitation'
type: array
- type: 'null'
title: Citation
clinical_impact_classification_description:
$ref: '#/components/schemas/SomaticClinicalImpactClassificationDescription'
comment:
anyOf:
- type: string
- type: 'null'
title: Comment
date_last_evaluated:
anyOf:
- type: string
- type: 'null'
title: Date Last Evaluated
drug_for_therapeutic_assertion:
anyOf:
- type: string
- type: 'null'
title: Drug For Therapeutic Assertion
required:
- clinical_impact_classification_description
title: SomaticClinicalImpactClassification
type: object
SomaticClinicalImpactClassificationDescription:
enum:
- Tier I - Strong
- Tier II - Potential
- Tier III - Unknown
- Tier IV - Benign/Likely benign
title: SomaticClinicalImpactClassificationDescription
type: string
SomaticOncogenicityClassification-Input:
description: Details of somatic clinical impact classification.
properties:
citation:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCitation'
type: array
- type: 'null'
title: Citation
comment:
anyOf:
- type: string
- type: 'null'
title: Comment
date_last_evaluated:
anyOf:
- type: string
- type: 'null'
title: Date Last Evaluated
oncogenicity_classification_description:
$ref: '#/components/schemas/OncogenicityClassificationDescription'
required:
- oncogenicity_classification_description
title: SomaticOncogenicityClassification
type: object
SomaticOncogenicityClassification-Output:
description: Details of somatic clinical impact classification.
properties:
citation:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCitation'
type: array
- type: 'null'
title: Citation
comment:
anyOf:
- type: string
- type: 'null'
title: Comment
date_last_evaluated:
anyOf:
- type: string
- type: 'null'
title: Date Last Evaluated
oncogenicity_classification_description:
$ref: '#/components/schemas/OncogenicityClassificationDescription'
required:
- oncogenicity_classification_description
title: SomaticOncogenicityClassification
type: object
StructVarMethodType:
enum:
- SNP array
- Oligo array
- Read depth
- Paired-end mapping
- One end anchored assembly
- Sequence alignment
- Optical mapping
- Curated,PCR
title: StructVarMethodType
type: string
SubmissionActivityCreate:
properties:
kind:
$ref: '#/components/schemas/SubmissionActivityKind'
request_payload:
anyOf:
- $ref: '#/components/schemas/SubmissionContainer-Input'
- type: 'null'
request_timestamp:
anyOf:
- format: date-time
type: string
- type: 'null'
title: Request Timestamp
response_payload:
anyOf:
- $ref: '#/components/schemas/ResponseMessage'
- $ref: '#/components/schemas/Created'
- $ref: '#/components/schemas/RetrieveStatusResult-Input'
- type: 'null'
title: Response Payload
response_timestamp:
anyOf:
- format: date-time
type: string
- type: 'null'
title: Response Timestamp
status:
$ref: '#/components/schemas/SubmissionActivityStatus'
submissionthread_id:
format: uuid
title: Submissionthread Id
type: string
required:
- kind
- status
- submissionthread_id
title: SubmissionActivityCreate
type: object
SubmissionActivityKind:
description: Type of the :ref:`SubmissionActivity`.
enum:
- create
- retrieve
- update
- delete
title: SubmissionActivityKind
type: string
SubmissionActivityRead:
properties:
created:
format: date-time
title: Created
type: string
id:
format: uuid
title: Id
type: string
kind:
$ref: '#/components/schemas/SubmissionActivityKind'
request_payload:
anyOf:
- $ref: '#/components/schemas/SubmissionContainer-Output'
- type: 'null'
request_timestamp:
anyOf:
- format: date-time
type: string
- type: 'null'
title: Request Timestamp
response_payload:
anyOf:
- $ref: '#/components/schemas/ResponseMessage'
- $ref: '#/components/schemas/Created'
- $ref: '#/components/schemas/RetrieveStatusResult-Output'
- type: 'null'
title: Response Payload
response_timestamp:
anyOf:
- format: date-time
type: string
- type: 'null'
title: Response Timestamp
status:
$ref: '#/components/schemas/SubmissionActivityStatus'
submissionthread_id:
format: uuid
title: Submissionthread Id
type: string
required:
- kind
- status
- id
- created
- submissionthread_id
title: SubmissionActivityRead
type: object
SubmissionActivityStatus:
description: 'Status of a :ref:`SubmissionActivity`.
An activity starts out waiting in the queue to be picked up by the
worker, goes on into being processed, and ends up being complete
or failed. An activity can also end up being in a timeout state.'
enum:
- initial
- waiting
- in_progress
- complete_success
- complete_failure
- complete_in_progress
- failed
- timeout
title: SubmissionActivityStatus
type: string
SubmissionActivityUpdate:
properties:
kind:
$ref: '#/components/schemas/SubmissionActivityKind'
request_payload:
anyOf:
- $ref: '#/components/schemas/SubmissionContainer-Input'
- type: 'null'
request_timestamp:
anyOf:
- format: date-time
type: string
- type: 'null'
title: Request Timestamp
response_payload:
anyOf:
- $ref: '#/components/schemas/ResponseMessage'
- $ref: '#/components/schemas/Created'
- $ref: '#/components/schemas/RetrieveStatusResult-Input'
- type: 'null'
title: Response Payload
response_timestamp:
anyOf:
- format: date-time
type: string
- type: 'null'
title: Response Timestamp
status:
$ref: '#/components/schemas/SubmissionActivityStatus'
required:
- kind
- status
title: SubmissionActivityUpdate
type: object
SubmissionAssertionCriteria:
properties:
db:
anyOf:
- $ref: '#/components/schemas/CitationDb'
- type: 'null'
id:
anyOf:
- type: string
- type: 'null'
title: Id
url:
anyOf:
- type: string
- type: 'null'
title: Url
title: SubmissionAssertionCriteria
type: object
SubmissionChromosomeCoordinates:
properties:
accession:
anyOf:
- type: string
- type: 'null'
title: Accession
alternate_allele:
anyOf:
- type: string
- type: 'null'
title: Alternate Allele
assembly:
anyOf:
- $ref: '#/components/schemas/Assembly'
- type: 'null'
chromosome:
anyOf:
- $ref: '#/components/schemas/Chromosome'
- type: 'null'
inner_start:
anyOf:
- type: integer
- type: 'null'
title: Inner Start
inner_stop:
anyOf:
- type: integer
- type: 'null'
title: Inner Stop
outer_start:
anyOf:
- type: integer
- type: 'null'
title: Outer Start
outer_stop:
anyOf:
- type: integer
- type: 'null'
title: Outer Stop
reference_allele:
anyOf:
- type: string
- type: 'null'
title: Reference Allele
start:
anyOf:
- type: integer
- type: 'null'
title: Start
stop:
anyOf:
- type: integer
- type: 'null'
title: Stop
variant_length:
anyOf:
- type: integer
- type: 'null'
title: Variant Length
title: SubmissionChromosomeCoordinates
type: object
SubmissionCitation:
properties:
db:
anyOf:
- $ref: '#/components/schemas/CitationDb'
- type: 'null'
id:
anyOf:
- type: string
- type: 'null'
title: Id
url:
anyOf:
- type: string
- type: 'null'
title: Url
title: SubmissionCitation
type: object
SubmissionClinicalFeature:
properties:
clinical_features_affected_status:
$ref: '#/components/schemas/ClinicalFeaturesAffectedStatus'
db:
anyOf:
- $ref: '#/components/schemas/ClinicalFeaturesDb'
- type: 'null'
id:
anyOf:
- type: string
- type: 'null'
title: Id
name:
anyOf:
- type: string
- type: 'null'
title: Name
required:
- clinical_features_affected_status
title: SubmissionClinicalFeature
type: object
SubmissionClinicalImpactSubmission-Input:
properties:
clinical_impact_classification:
$ref: '#/components/schemas/SomaticClinicalImpactClassification-Input'
clinvar_accession:
anyOf:
- type: string
- type: 'null'
title: Clinvar Accession
compound_heterozygote_set:
anyOf:
- $ref: '#/components/schemas/SubmissionCompoundHeterozygoteSet-Input'
- type: 'null'
condition_set:
$ref: '#/components/schemas/SubmissionConditionSetSomatic-Input'
diplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDiplotypeSet-Input'
- type: 'null'
distinct_chromosomes_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDistinctChromosomesSet-Input'
- type: 'null'
extra_data:
anyOf:
- type: object
- type: 'null'
title: Extra Data
haplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Input'
- type: 'null'
haplotype_single_variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Input'
- type: 'null'
local_id:
anyOf:
- type: string
- type: 'null'
title: Local Id
local_key:
anyOf:
- type: string
- type: 'null'
title: Local Key
observed_in:
items:
$ref: '#/components/schemas/SubmissionObservedInSomatic-Input'
title: Observed In
type: array
phase_unknown_set:
anyOf:
- $ref: '#/components/schemas/SubmissionPhaseUnknownSet-Input'
- type: 'null'
record_status:
$ref: '#/components/schemas/RecordStatus'
variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionVariantSet-Input'
- type: 'null'
required:
- record_status
- clinical_impact_classification
- condition_set
- observed_in
title: SubmissionClinicalImpactSubmission
type: object
SubmissionClinicalImpactSubmission-Output:
properties:
clinical_impact_classification:
$ref: '#/components/schemas/SomaticClinicalImpactClassification-Output'
clinvar_accession:
anyOf:
- type: string
- type: 'null'
title: Clinvar Accession
compound_heterozygote_set:
anyOf:
- $ref: '#/components/schemas/SubmissionCompoundHeterozygoteSet-Output'
- type: 'null'
condition_set:
$ref: '#/components/schemas/SubmissionConditionSetSomatic-Output'
diplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDiplotypeSet-Output'
- type: 'null'
distinct_chromosomes_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDistinctChromosomesSet-Output'
- type: 'null'
extra_data:
anyOf:
- type: object
- type: 'null'
title: Extra Data
haplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Output'
- type: 'null'
haplotype_single_variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Output'
- type: 'null'
local_id:
anyOf:
- type: string
- type: 'null'
title: Local Id
local_key:
anyOf:
- type: string
- type: 'null'
title: Local Key
observed_in:
items:
$ref: '#/components/schemas/SubmissionObservedInSomatic-Output'
title: Observed In
type: array
phase_unknown_set:
anyOf:
- $ref: '#/components/schemas/SubmissionPhaseUnknownSet-Output'
- type: 'null'
record_status:
$ref: '#/components/schemas/RecordStatus'
variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionVariantSet-Output'
- type: 'null'
required:
- record_status
- clinical_impact_classification
- condition_set
- observed_in
title: SubmissionClinicalImpactSubmission
type: object
SubmissionClinicalSignificance-Input:
properties:
citation:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCitation'
type: array
- type: 'null'
title: Citation
clinical_significance_description:
$ref: '#/components/schemas/ClinicalSignificanceDescription'
comment:
anyOf:
- type: string
- type: 'null'
title: Comment
custom_assertion_score:
anyOf:
- type: number
- type: 'null'
title: Custom Assertion Score
date_last_evaluated:
anyOf:
- type: string
- type: 'null'
title: Date Last Evaluated
explanation_of_drug_response:
anyOf:
- type: string
- type: 'null'
title: Explanation Of Drug Response
explanation_of_other_clinical_significance:
anyOf:
- type: string
- type: 'null'
title: Explanation Of Other Clinical Significance
mode_of_inheritance:
anyOf:
- $ref: '#/components/schemas/ModeOfInheritance'
- type: 'null'
required:
- clinical_significance_description
title: SubmissionClinicalSignificance
type: object
SubmissionClinicalSignificance-Output:
properties:
citation:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCitation'
type: array
- type: 'null'
title: Citation
clinical_significance_description:
$ref: '#/components/schemas/ClinicalSignificanceDescription'
comment:
anyOf:
- type: string
- type: 'null'
title: Comment
custom_assertion_score:
anyOf:
- type: number
- type: 'null'
title: Custom Assertion Score
date_last_evaluated:
anyOf:
- type: string
- type: 'null'
title: Date Last Evaluated
explanation_of_drug_response:
anyOf:
- type: string
- type: 'null'
title: Explanation Of Drug Response
explanation_of_other_clinical_significance:
anyOf:
- type: string
- type: 'null'
title: Explanation Of Other Clinical Significance
mode_of_inheritance:
anyOf:
- $ref: '#/components/schemas/ModeOfInheritance'
- type: 'null'
required:
- clinical_significance_description
title: SubmissionClinicalSignificance
type: object
SubmissionClinvarDeletion:
properties:
accession_set:
items:
$ref: '#/components/schemas/SubmissionClinvarDeletionAccessionSet'
title: Accession Set
type: array
required:
- accession_set
title: SubmissionClinvarDeletion
type: object
SubmissionClinvarDeletionAccessionSet:
properties:
accession:
title: Accession
type: string
reason:
anyOf:
- type: string
- type: 'null'
title: Reason
required:
- accession
title: SubmissionClinvarDeletionAccessionSet
type: object
SubmissionClinvarSubmission-Input:
properties:
clinical_significance:
$ref: '#/components/schemas/SubmissionClinicalSignificance-Input'
clinvar_accession:
anyOf:
- type: string
- type: 'null'
title: Clinvar Accession
compound_heterozygote_set:
anyOf:
- $ref: '#/components/schemas/SubmissionCompoundHeterozygoteSet-Input'
- type: 'null'
condition_set:
$ref: '#/components/schemas/SubmissionConditionSetGermline-Input'
diplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDiplotypeSet-Input'
- type: 'null'
distinct_chromosomes_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDistinctChromosomesSet-Input'
- type: 'null'
extra_data:
anyOf:
- type: object
- type: 'null'
title: Extra Data
haplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Input'
- type: 'null'
haplotype_single_variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Input'
- type: 'null'
local_id:
anyOf:
- type: string
- type: 'null'
title: Local Id
local_key:
anyOf:
- type: string
- type: 'null'
title: Local Key
observed_in:
items:
$ref: '#/components/schemas/SubmissionObservedInGermline-Input'
title: Observed In
type: array
phase_unknown_set:
anyOf:
- $ref: '#/components/schemas/SubmissionPhaseUnknownSet-Input'
- type: 'null'
record_status:
$ref: '#/components/schemas/RecordStatus'
variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionVariantSet-Input'
- type: 'null'
required:
- record_status
- clinical_significance
- condition_set
- observed_in
title: SubmissionClinvarSubmission
type: object
SubmissionClinvarSubmission-Output:
properties:
clinical_significance:
$ref: '#/components/schemas/SubmissionClinicalSignificance-Output'
clinvar_accession:
anyOf:
- type: string
- type: 'null'
title: Clinvar Accession
compound_heterozygote_set:
anyOf:
- $ref: '#/components/schemas/SubmissionCompoundHeterozygoteSet-Output'
- type: 'null'
condition_set:
$ref: '#/components/schemas/SubmissionConditionSetGermline-Output'
diplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDiplotypeSet-Output'
- type: 'null'
distinct_chromosomes_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDistinctChromosomesSet-Output'
- type: 'null'
extra_data:
anyOf:
- type: object
- type: 'null'
title: Extra Data
haplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Output'
- type: 'null'
haplotype_single_variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Output'
- type: 'null'
local_id:
anyOf:
- type: string
- type: 'null'
title: Local Id
local_key:
anyOf:
- type: string
- type: 'null'
title: Local Key
observed_in:
items:
$ref: '#/components/schemas/SubmissionObservedInGermline-Output'
title: Observed In
type: array
phase_unknown_set:
anyOf:
- $ref: '#/components/schemas/SubmissionPhaseUnknownSet-Output'
- type: 'null'
record_status:
$ref: '#/components/schemas/RecordStatus'
variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionVariantSet-Output'
- type: 'null'
required:
- record_status
- clinical_significance
- condition_set
- observed_in
title: SubmissionClinvarSubmission
type: object
SubmissionCompoundHeterozygoteSet-Input:
properties:
hgvs:
title: Hgvs
type: string
variant_sets:
items:
$ref: '#/components/schemas/SubmissionCompoundHeterozygoteSetVariantSet-Input'
title: Variant Sets
type: array
required:
- hgvs
- variant_sets
title: SubmissionCompoundHeterozygoteSet
type: object
SubmissionCompoundHeterozygoteSet-Output:
properties:
hgvs:
title: Hgvs
type: string
variant_sets:
items:
$ref: '#/components/schemas/SubmissionCompoundHeterozygoteSetVariantSet-Output'
title: Variant Sets
type: array
required:
- hgvs
- variant_sets
title: SubmissionCompoundHeterozygoteSet
type: object
SubmissionCompoundHeterozygoteSetVariantSet-Input:
properties:
variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionVariantSet-Input'
- type: 'null'
title: SubmissionCompoundHeterozygoteSetVariantSet
type: object
SubmissionCompoundHeterozygoteSetVariantSet-Output:
properties:
variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionVariantSet-Output'
- type: 'null'
title: SubmissionCompoundHeterozygoteSetVariantSet
type: object
SubmissionCondition:
properties:
db:
anyOf:
- $ref: '#/components/schemas/ConditionDb'
- type: 'null'
id:
anyOf:
- type: string
- type: 'null'
title: Id
name:
anyOf:
- type: string
- type: 'null'
title: Name
title: SubmissionCondition
type: object
SubmissionConditionSetGermline-Input:
properties:
condition:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCondition'
type: array
- type: 'null'
title: Condition
drug_response:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionDrugResponse-Input'
type: array
- type: 'null'
title: Drug Response
multiple_condition_explanation:
anyOf:
- $ref: '#/components/schemas/MultipleConditionExplanation'
- type: 'null'
title: SubmissionConditionSetGermline
type: object
SubmissionConditionSetGermline-Output:
properties:
condition:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCondition'
type: array
- type: 'null'
title: Condition
drug_response:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionDrugResponse-Output'
type: array
- type: 'null'
title: Drug Response
multiple_condition_explanation:
anyOf:
- $ref: '#/components/schemas/MultipleConditionExplanation'
- type: 'null'
title: SubmissionConditionSetGermline
type: object
SubmissionConditionSetSomatic-Input:
properties:
condition:
items:
$ref: '#/components/schemas/SubmissionCondition'
title: Condition
type: array
drug_response:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionDrugResponse-Input'
type: array
- type: 'null'
title: Drug Response
multiple_condition_explanation:
anyOf:
- $ref: '#/components/schemas/MultipleConditionExplanation'
- type: 'null'
required:
- condition
title: SubmissionConditionSetSomatic
type: object
SubmissionConditionSetSomatic-Output:
properties:
condition:
items:
$ref: '#/components/schemas/SubmissionCondition'
title: Condition
type: array
drug_response:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionDrugResponse-Output'
type: array
- type: 'null'
title: Drug Response
multiple_condition_explanation:
anyOf:
- $ref: '#/components/schemas/MultipleConditionExplanation'
- type: 'null'
required:
- condition
title: SubmissionConditionSetSomatic
type: object
SubmissionContainer-Input:
properties:
assertion_criteria:
anyOf:
- $ref: '#/components/schemas/SubmissionAssertionCriteria'
- type: 'null'
behalf_org_id:
anyOf:
- type: integer
- type: 'null'
title: Behalf Org Id
clinical_impact_submission:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionClinicalImpactSubmission-Input'
type: array
- type: 'null'
title: Clinical Impact Submission
clinvar_deletion:
anyOf:
- $ref: '#/components/schemas/SubmissionClinvarDeletion'
- type: 'null'
clinvar_submission:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionClinvarSubmission-Input'
type: array
- type: 'null'
title: Clinvar Submission
clinvar_submission_release_status:
anyOf:
- $ref: '#/components/schemas/ReleaseStatus'
- type: 'null'
germline_submission:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionGermlineSubmission-Input'
type: array
- type: 'null'
title: Germline Submission
oncogenicity_submission:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionOncogenicitySubmission-Input'
type: array
- type: 'null'
title: Oncogenicity Submission
submission_name:
anyOf:
- type: string
- type: 'null'
title: Submission Name
title: SubmissionContainer
type: object
SubmissionContainer-Output:
properties:
assertion_criteria:
anyOf:
- $ref: '#/components/schemas/SubmissionAssertionCriteria'
- type: 'null'
behalf_org_id:
anyOf:
- type: integer
- type: 'null'
title: Behalf Org Id
clinical_impact_submission:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionClinicalImpactSubmission-Output'
type: array
- type: 'null'
title: Clinical Impact Submission
clinvar_deletion:
anyOf:
- $ref: '#/components/schemas/SubmissionClinvarDeletion'
- type: 'null'
clinvar_submission:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionClinvarSubmission-Output'
type: array
- type: 'null'
title: Clinvar Submission
clinvar_submission_release_status:
anyOf:
- $ref: '#/components/schemas/ReleaseStatus'
- type: 'null'
germline_submission:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionGermlineSubmission-Output'
type: array
- type: 'null'
title: Germline Submission
oncogenicity_submission:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionOncogenicitySubmission-Output'
type: array
- type: 'null'
title: Oncogenicity Submission
submission_name:
anyOf:
- type: string
- type: 'null'
title: Submission Name
title: SubmissionContainer
type: object
SubmissionDiplotypeSet-Input:
properties:
haplotype_sets:
items:
$ref: '#/components/schemas/SubmissionHaplotypeSets-Input'
title: Haplotype Sets
type: array
hgvs:
title: Hgvs
type: string
star_allele_name:
anyOf:
- type: string
- type: 'null'
title: Star Allele Name
required:
- haplotype_sets
- hgvs
title: SubmissionDiplotypeSet
type: object
SubmissionDiplotypeSet-Output:
properties:
haplotype_sets:
items:
$ref: '#/components/schemas/SubmissionHaplotypeSets-Output'
title: Haplotype Sets
type: array
hgvs:
title: Hgvs
type: string
star_allele_name:
anyOf:
- type: string
- type: 'null'
title: Star Allele Name
required:
- haplotype_sets
- hgvs
title: SubmissionDiplotypeSet
type: object
SubmissionDistinctChromosomesSet-Input:
properties:
hgvs:
title: Hgvs
type: string
variants:
items:
$ref: '#/components/schemas/SubmissionVariant-Input'
title: Variants
type: array
required:
- hgvs
- variants
title: SubmissionDistinctChromosomesSet
type: object
SubmissionDistinctChromosomesSet-Output:
properties:
hgvs:
title: Hgvs
type: string
variants:
items:
$ref: '#/components/schemas/SubmissionVariant-Output'
title: Variants
type: array
required:
- hgvs
- variants
title: SubmissionDistinctChromosomesSet
type: object
SubmissionDrugResponse-Input:
properties:
condition:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCondition'
type: array
- type: 'null'
title: Condition
db:
anyOf:
- $ref: '#/components/schemas/ConditionDb'
- type: 'null'
drug_name:
anyOf:
- type: string
- type: 'null'
title: Drug Name
id:
anyOf:
- type: string
- type: 'null'
title: Id
title: SubmissionDrugResponse
type: object
SubmissionDrugResponse-Output:
properties:
condition:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionCondition'
type: array
- type: 'null'
title: Condition
db:
anyOf:
- $ref: '#/components/schemas/ConditionDb'
- type: 'null'
drug_name:
anyOf:
- type: string
- type: 'null'
title: Drug Name
id:
anyOf:
- type: string
- type: 'null'
title: Id
title: SubmissionDrugResponse
type: object
SubmissionGermlineSubmission-Input:
properties:
clinvar_accession:
anyOf:
- type: string
- type: 'null'
title: Clinvar Accession
compound_heterozygote_set:
anyOf:
- $ref: '#/components/schemas/SubmissionCompoundHeterozygoteSet-Input'
- type: 'null'
condition_set:
$ref: '#/components/schemas/SubmissionConditionSetGermline-Input'
diplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDiplotypeSet-Input'
- type: 'null'
distinct_chromosomes_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDistinctChromosomesSet-Input'
- type: 'null'
extra_data:
anyOf:
- type: object
- type: 'null'
title: Extra Data
germline_classification:
$ref: '#/components/schemas/GermlineClassification-Input'
haplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Input'
- type: 'null'
haplotype_single_variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Input'
- type: 'null'
local_id:
anyOf:
- type: string
- type: 'null'
title: Local Id
local_key:
anyOf:
- type: string
- type: 'null'
title: Local Key
observed_in:
items:
$ref: '#/components/schemas/SubmissionObservedInGermline-Input'
title: Observed In
type: array
phase_unknown_set:
anyOf:
- $ref: '#/components/schemas/SubmissionPhaseUnknownSet-Input'
- type: 'null'
record_status:
$ref: '#/components/schemas/RecordStatus'
variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionVariantSet-Input'
- type: 'null'
required:
- record_status
- germline_classification
- condition_set
- observed_in
title: SubmissionGermlineSubmission
type: object
SubmissionGermlineSubmission-Output:
properties:
clinvar_accession:
anyOf:
- type: string
- type: 'null'
title: Clinvar Accession
compound_heterozygote_set:
anyOf:
- $ref: '#/components/schemas/SubmissionCompoundHeterozygoteSet-Output'
- type: 'null'
condition_set:
$ref: '#/components/schemas/SubmissionConditionSetGermline-Output'
diplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDiplotypeSet-Output'
- type: 'null'
distinct_chromosomes_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDistinctChromosomesSet-Output'
- type: 'null'
extra_data:
anyOf:
- type: object
- type: 'null'
title: Extra Data
germline_classification:
$ref: '#/components/schemas/GermlineClassification-Output'
haplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Output'
- type: 'null'
haplotype_single_variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Output'
- type: 'null'
local_id:
anyOf:
- type: string
- type: 'null'
title: Local Id
local_key:
anyOf:
- type: string
- type: 'null'
title: Local Key
observed_in:
items:
$ref: '#/components/schemas/SubmissionObservedInGermline-Output'
title: Observed In
type: array
phase_unknown_set:
anyOf:
- $ref: '#/components/schemas/SubmissionPhaseUnknownSet-Output'
- type: 'null'
record_status:
$ref: '#/components/schemas/RecordStatus'
variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionVariantSet-Output'
- type: 'null'
required:
- record_status
- germline_classification
- condition_set
- observed_in
title: SubmissionGermlineSubmission
type: object
SubmissionHaplotypeSet-Input:
properties:
hgvs:
title: Hgvs
type: string
star_allele_name:
anyOf:
- type: string
- type: 'null'
title: Star Allele Name
variants:
items:
$ref: '#/components/schemas/SubmissionVariant-Input'
title: Variants
type: array
required:
- hgvs
- variants
title: SubmissionHaplotypeSet
type: object
SubmissionHaplotypeSet-Output:
properties:
hgvs:
title: Hgvs
type: string
star_allele_name:
anyOf:
- type: string
- type: 'null'
title: Star Allele Name
variants:
items:
$ref: '#/components/schemas/SubmissionVariant-Output'
title: Variants
type: array
required:
- hgvs
- variants
title: SubmissionHaplotypeSet
type: object
SubmissionHaplotypeSets-Input:
properties:
haplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Input'
- type: 'null'
haplotype_single_variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Input'
- type: 'null'
title: SubmissionHaplotypeSets
type: object
SubmissionHaplotypeSets-Output:
properties:
haplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Output'
- type: 'null'
haplotype_single_variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Output'
- type: 'null'
title: SubmissionHaplotypeSets
type: object
SubmissionObservedInGermline-Input:
properties:
affected_status:
$ref: '#/components/schemas/AffectedStatus'
allele_origin:
$ref: '#/components/schemas/AlleleOrigin'
clinical_features:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionClinicalFeature'
type: array
- type: 'null'
title: Clinical Features
clinical_features_comment:
anyOf:
- type: string
- type: 'null'
title: Clinical Features Comment
collection_method:
$ref: '#/components/schemas/CollectionMethod'
number_of_individuals:
anyOf:
- type: integer
- type: 'null'
title: Number Of Individuals
struct_var_method_type:
anyOf:
- $ref: '#/components/schemas/StructVarMethodType'
- type: 'null'
required:
- affected_status
- allele_origin
- collection_method
title: SubmissionObservedInGermline
type: object
SubmissionObservedInGermline-Output:
properties:
affected_status:
$ref: '#/components/schemas/AffectedStatus'
allele_origin:
$ref: '#/components/schemas/AlleleOrigin'
clinical_features:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionClinicalFeature'
type: array
- type: 'null'
title: Clinical Features
clinical_features_comment:
anyOf:
- type: string
- type: 'null'
title: Clinical Features Comment
collection_method:
$ref: '#/components/schemas/CollectionMethod'
number_of_individuals:
anyOf:
- type: integer
- type: 'null'
title: Number Of Individuals
struct_var_method_type:
anyOf:
- $ref: '#/components/schemas/StructVarMethodType'
- type: 'null'
required:
- affected_status
- allele_origin
- collection_method
title: SubmissionObservedInGermline
type: object
SubmissionObservedInSomatic-Input:
properties:
affected_status:
$ref: '#/components/schemas/AffectedStatus'
allele_origin:
$ref: '#/components/schemas/AlleleOrigin'
clinical_features:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionClinicalFeature'
type: array
- type: 'null'
title: Clinical Features
clinical_features_comment:
anyOf:
- type: string
- type: 'null'
title: Clinical Features Comment
collection_method:
$ref: '#/components/schemas/CollectionMethod'
number_of_individuals:
anyOf:
- type: integer
- type: 'null'
title: Number Of Individuals
presence_of_somatic_variant_in_normal_tissue:
anyOf:
- $ref: '#/components/schemas/PresenceOfSomaticVariantInNormalTissue'
- type: 'null'
somatic_variant_allele_fraction:
anyOf:
- type: number
- type: 'null'
title: Somatic Variant Allele Fraction
struct_var_method_type:
anyOf:
- $ref: '#/components/schemas/StructVarMethodType'
- type: 'null'
required:
- affected_status
- allele_origin
- collection_method
title: SubmissionObservedInSomatic
type: object
SubmissionObservedInSomatic-Output:
properties:
affected_status:
$ref: '#/components/schemas/AffectedStatus'
allele_origin:
$ref: '#/components/schemas/AlleleOrigin'
clinical_features:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionClinicalFeature'
type: array
- type: 'null'
title: Clinical Features
clinical_features_comment:
anyOf:
- type: string
- type: 'null'
title: Clinical Features Comment
collection_method:
$ref: '#/components/schemas/CollectionMethod'
number_of_individuals:
anyOf:
- type: integer
- type: 'null'
title: Number Of Individuals
presence_of_somatic_variant_in_normal_tissue:
anyOf:
- $ref: '#/components/schemas/PresenceOfSomaticVariantInNormalTissue'
- type: 'null'
somatic_variant_allele_fraction:
anyOf:
- type: number
- type: 'null'
title: Somatic Variant Allele Fraction
struct_var_method_type:
anyOf:
- $ref: '#/components/schemas/StructVarMethodType'
- type: 'null'
required:
- affected_status
- allele_origin
- collection_method
title: SubmissionObservedInSomatic
type: object
SubmissionOncogenicitySubmission-Input:
properties:
clinvar_accession:
anyOf:
- type: string
- type: 'null'
title: Clinvar Accession
compound_heterozygote_set:
anyOf:
- $ref: '#/components/schemas/SubmissionCompoundHeterozygoteSet-Input'
- type: 'null'
condition_set:
$ref: '#/components/schemas/SubmissionConditionSetSomatic-Input'
diplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDiplotypeSet-Input'
- type: 'null'
distinct_chromosomes_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDistinctChromosomesSet-Input'
- type: 'null'
extra_data:
anyOf:
- type: object
- type: 'null'
title: Extra Data
haplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Input'
- type: 'null'
haplotype_single_variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Input'
- type: 'null'
local_id:
anyOf:
- type: string
- type: 'null'
title: Local Id
local_key:
anyOf:
- type: string
- type: 'null'
title: Local Key
observed_in:
items:
$ref: '#/components/schemas/SubmissionObservedInSomatic-Input'
title: Observed In
type: array
oncogenicity_classification:
$ref: '#/components/schemas/SomaticOncogenicityClassification-Input'
phase_unknown_set:
anyOf:
- $ref: '#/components/schemas/SubmissionPhaseUnknownSet-Input'
- type: 'null'
record_status:
$ref: '#/components/schemas/RecordStatus'
variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionVariantSet-Input'
- type: 'null'
required:
- record_status
- oncogenicity_classification
- condition_set
- observed_in
title: SubmissionOncogenicitySubmission
type: object
SubmissionOncogenicitySubmission-Output:
properties:
clinvar_accession:
anyOf:
- type: string
- type: 'null'
title: Clinvar Accession
compound_heterozygote_set:
anyOf:
- $ref: '#/components/schemas/SubmissionCompoundHeterozygoteSet-Output'
- type: 'null'
condition_set:
$ref: '#/components/schemas/SubmissionConditionSetSomatic-Output'
diplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDiplotypeSet-Output'
- type: 'null'
distinct_chromosomes_set:
anyOf:
- $ref: '#/components/schemas/SubmissionDistinctChromosomesSet-Output'
- type: 'null'
extra_data:
anyOf:
- type: object
- type: 'null'
title: Extra Data
haplotype_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Output'
- type: 'null'
haplotype_single_variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionHaplotypeSet-Output'
- type: 'null'
local_id:
anyOf:
- type: string
- type: 'null'
title: Local Id
local_key:
anyOf:
- type: string
- type: 'null'
title: Local Key
observed_in:
items:
$ref: '#/components/schemas/SubmissionObservedInSomatic-Output'
title: Observed In
type: array
oncogenicity_classification:
$ref: '#/components/schemas/SomaticOncogenicityClassification-Output'
phase_unknown_set:
anyOf:
- $ref: '#/components/schemas/SubmissionPhaseUnknownSet-Output'
- type: 'null'
record_status:
$ref: '#/components/schemas/RecordStatus'
variant_set:
anyOf:
- $ref: '#/components/schemas/SubmissionVariantSet-Output'
- type: 'null'
required:
- record_status
- oncogenicity_classification
- condition_set
- observed_in
title: SubmissionOncogenicitySubmission
type: object
SubmissionPhaseUnknownSet-Input:
properties:
hgvs:
title: Hgvs
type: string
variants:
items:
$ref: '#/components/schemas/SubmissionVariant-Input'
title: Variants
type: array
required:
- hgvs
- variants
title: SubmissionPhaseUnknownSet
type: object
SubmissionPhaseUnknownSet-Output:
properties:
hgvs:
title: Hgvs
type: string
variants:
items:
$ref: '#/components/schemas/SubmissionVariant-Output'
title: Variants
type: array
required:
- hgvs
- variants
title: SubmissionPhaseUnknownSet
type: object
SubmissionStatus-Input:
description: Internal submission status.
properties:
actions:
items:
$ref: '#/components/schemas/SubmissionStatusActions-Input'
title: Actions
type: array
required:
- actions
title: SubmissionStatus
type: object
SubmissionStatus-Output:
description: Internal submission status.
properties:
actions:
items:
$ref: '#/components/schemas/SubmissionStatusActions-Output'
title: Actions
type: array
required:
- actions
title: SubmissionStatus
type: object
SubmissionStatusActions-Input:
properties:
id:
title: Id
type: string
responses:
items:
$ref: '#/components/schemas/SubmissionStatusResponse-Input'
title: Responses
type: array
status:
title: Status
type: string
target_db:
title: Target Db
type: string
updated:
format: date-time
title: Updated
type: string
required:
- id
- responses
- status
- target_db
- updated
title: SubmissionStatusActions
type: object
SubmissionStatusActions-Output:
properties:
id:
title: Id
type: string
responses:
items:
$ref: '#/components/schemas/SubmissionStatusResponse-Output'
title: Responses
type: array
status:
title: Status
type: string
target_db:
title: Target Db
type: string
updated:
format: date-time
title: Updated
type: string
required:
- id
- responses
- status
- target_db
- updated
title: SubmissionStatusActions
type: object
SubmissionStatusFile:
properties:
url:
title: Url
type: string
required:
- url
title: SubmissionStatusFile
type: object
SubmissionStatusObject:
properties:
accession:
anyOf:
- type: string
- type: 'null'
title: Accession
content:
$ref: '#/components/schemas/SubmissionStatusObjectContent'
target_db:
title: Target Db
type: string
required:
- accession
- content
- target_db
title: SubmissionStatusObject
type: object
SubmissionStatusObjectContent:
properties:
clinvar_processing_status:
title: Clinvar Processing Status
type: string
clinvar_release_status:
title: Clinvar Release Status
type: string
required:
- clinvar_processing_status
- clinvar_release_status
title: SubmissionStatusObjectContent
type: object
SubmissionStatusResponse-Input:
properties:
files:
items:
$ref: '#/components/schemas/SubmissionStatusFile'
title: Files
type: array
message:
anyOf:
- $ref: '#/components/schemas/SubmissionStatusResponseMessage'
- type: 'null'
objects:
items:
$ref: '#/components/schemas/SubmissionStatusObject'
title: Objects
type: array
status:
title: Status
type: string
required:
- status
- files
- message
- objects
title: SubmissionStatusResponse
type: object
SubmissionStatusResponse-Output:
properties:
files:
items:
$ref: '#/components/schemas/SubmissionStatusFile'
title: Files
type: array
message:
anyOf:
- $ref: '#/components/schemas/SubmissionStatusResponseMessage'
- type: 'null'
objects:
items:
$ref: '#/components/schemas/SubmissionStatusObject'
title: Objects
type: array
status:
title: Status
type: string
required:
- status
- files
- message
- objects
title: SubmissionStatusResponse
type: object
SubmissionStatusResponseMessage:
properties:
error_code:
anyOf:
- $ref: '#/components/schemas/ErrorCode'
- type: 'null'
severity:
title: Severity
type: string
text:
title: Text
type: string
required:
- error_code
- severity
- text
title: SubmissionStatusResponseMessage
type: object
SubmissionThreadCreate:
properties:
desired_presence:
$ref: '#/components/schemas/VariantPresence'
effective_presence:
anyOf:
- $ref: '#/components/schemas/VariantPresence'
- type: 'null'
effective_scv:
anyOf:
- type: string
- type: 'null'
title: Effective Scv
primary_variant_desc:
minLength: 1
pattern: ^(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-([CGAT]+)-([CGAT]+)$|^(DEL|DUP)-(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-(\d+)$
title: Primary Variant Desc
type: string
status:
$ref: '#/components/schemas/SubmissionThreadStatus'
submittingorg_id:
format: uuid
title: Submittingorg Id
type: string
required:
- desired_presence
- status
- submittingorg_id
- primary_variant_desc
title: SubmissionThreadCreate
type: object
SubmissionThreadRead:
properties:
created:
format: date-time
title: Created
type: string
desired_presence:
$ref: '#/components/schemas/VariantPresence'
effective_presence:
anyOf:
- $ref: '#/components/schemas/VariantPresence'
- type: 'null'
effective_scv:
anyOf:
- type: string
- type: 'null'
title: Effective Scv
id:
format: uuid
title: Id
type: string
primary_variant_desc:
minLength: 1
pattern: ^(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-([CGAT]+)-([CGAT]+)$|^(DEL|DUP)-(grch37|grch38)-([1-9]|1[0-9]|2[12]|X|Y|MT)-(\d+)-(\d+)$
title: Primary Variant Desc
type: string
status:
$ref: '#/components/schemas/SubmissionThreadStatus'
submittingorg_id:
format: uuid
title: Submittingorg Id
type: string
updated:
format: date-time
title: Updated
type: string
required:
- desired_presence
- status
- id
- created
- updated
- submittingorg_id
- primary_variant_desc
title: SubmissionThreadRead
type: object
SubmissionThreadStatus:
description: 'Status of a :ref:`SubmissionThread`.
A thread starts out being in initial state while being edit by the
user. It is then submitted into the work queue together with an
initial activity where it is waiting to be processed. It is then
worked on in the form of activities and ends up being complete or
failed. If the latest activity runs into a timeout (e.g., worker
death) then this is reflected on the thread as well.'
enum:
- initial
- waiting
- in_progress
- success
- failed
title: SubmissionThreadStatus
type: string
SubmissionThreadUpdate:
properties:
desired_presence:
$ref: '#/components/schemas/VariantPresence'
effective_presence:
anyOf:
- $ref: '#/components/schemas/VariantPresence'
- type: 'null'
effective_scv:
anyOf:
- type: string
- type: 'null'
title: Effective Scv
status:
$ref: '#/components/schemas/SubmissionThreadStatus'
required:
- desired_presence
- status
title: SubmissionThreadUpdate
type: object
SubmissionVariant-Input:
properties:
chromosome_coordinates:
anyOf:
- $ref: '#/components/schemas/SubmissionChromosomeCoordinates'
- type: 'null'
copy_number:
anyOf:
- type: string
- type: 'null'
title: Copy Number
gene:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionVariantGene'
type: array
- type: 'null'
title: Gene
hgvs:
anyOf:
- type: string
- type: 'null'
title: Hgvs
reference_copy_number:
anyOf:
- type: integer
- type: 'null'
title: Reference Copy Number
variant_type:
anyOf:
- $ref: '#/components/schemas/VariantType'
- type: 'null'
title: SubmissionVariant
type: object
SubmissionVariant-Output:
properties:
chromosome_coordinates:
anyOf:
- $ref: '#/components/schemas/SubmissionChromosomeCoordinates'
- type: 'null'
copy_number:
anyOf:
- type: string
- type: 'null'
title: Copy Number
gene:
anyOf:
- items:
$ref: '#/components/schemas/SubmissionVariantGene'
type: array
- type: 'null'
title: Gene
hgvs:
anyOf:
- type: string
- type: 'null'
title: Hgvs
reference_copy_number:
anyOf:
- type: integer
- type: 'null'
title: Reference Copy Number
variant_type:
anyOf:
- $ref: '#/components/schemas/VariantType'
- type: 'null'
title: SubmissionVariant
type: object
SubmissionVariantGene:
properties:
id:
anyOf:
- type: integer
- type: 'null'
title: Id
symbol:
anyOf:
- type: string
- type: 'null'
title: Symbol
title: SubmissionVariantGene
type: object
SubmissionVariantSet-Input:
properties:
variant:
items:
$ref: '#/components/schemas/SubmissionVariant-Input'
title: Variant
type: array
required:
- variant
title: SubmissionVariantSet
type: object
SubmissionVariantSet-Output:
properties:
variant:
items:
$ref: '#/components/schemas/SubmissionVariant-Output'
title: Variant
type: array
required:
- variant
title: SubmissionVariantSet
type: object
SubmittingOrgCreate:
properties:
clinvar_api_token:
title: Clinvar Api Token
type: string
label:
title: Label
type: string
owner:
anyOf:
- format: uuid
type: string
- type: 'null'
title: Owner
required:
- label
- clinvar_api_token
title: SubmittingOrgCreate
type: object
SubmittingOrgRead:
properties:
created:
format: date-time
title: Created
type: string
id:
format: uuid
title: Id
type: string
label:
title: Label
type: string
owner:
format: uuid
title: Owner
type: string
updated:
format: date-time
title: Updated
type: string
required:
- owner
- label
- id
- created
- updated
title: SubmittingOrgRead
type: object
SubmittingOrgUpdate:
properties:
clinvar_api_token:
anyOf:
- type: string
- type: 'null'
title: Clinvar Api Token
label:
title: Label
type: string
owner:
anyOf:
- format: uuid
type: string
- type: 'null'
title: Owner
required:
- label
title: SubmittingOrgUpdate
type: object
SummaryResponse-Input:
description: Represetation of server's response to a submission.
properties:
batch_processing_status:
$ref: '#/components/schemas/BatchProcessingStatus'
batch_release_status:
$ref: '#/components/schemas/BatchReleaseStatus'
deletions:
anyOf:
- items:
$ref: '#/components/schemas/SummaryResponseDeletion-Input'
type: array
- type: 'null'
title: Deletions
submission_date:
title: Submission Date
type: string
submission_name:
title: Submission Name
type: string
submissions:
anyOf:
- items:
$ref: '#/components/schemas/SummaryResponseSubmission-Input'
type: array
- type: 'null'
title: Submissions
total_count:
title: Total Count
type: integer
total_delete_count:
anyOf:
- type: integer
- type: 'null'
title: Total Delete Count
total_delete_errors:
anyOf:
- type: integer
- type: 'null'
title: Total Delete Errors
total_delete_success:
anyOf:
- type: integer
- type: 'null'
title: Total Delete Success
total_deleted:
anyOf:
- type: integer
- type: 'null'
title: Total Deleted
total_errors:
title: Total Errors
type: integer
total_public:
title: Total Public
type: integer
total_success:
title: Total Success
type: integer
required:
- batch_processing_status
- batch_release_status
- submission_date
- submission_name
- total_count
- total_errors
- total_public
- total_success
title: SummaryResponse
type: object
SummaryResponse-Output:
description: Represetation of server's response to a submission.
properties:
batch_processing_status:
$ref: '#/components/schemas/BatchProcessingStatus'
batch_release_status:
$ref: '#/components/schemas/BatchReleaseStatus'
deletions:
anyOf:
- items:
$ref: '#/components/schemas/SummaryResponseDeletion-Output'
type: array
- type: 'null'
title: Deletions
submission_date:
title: Submission Date
type: string
submission_name:
title: Submission Name
type: string
submissions:
anyOf:
- items:
$ref: '#/components/schemas/SummaryResponseSubmission-Output'
type: array
- type: 'null'
title: Submissions
total_count:
title: Total Count
type: integer
total_delete_count:
anyOf:
- type: integer
- type: 'null'
title: Total Delete Count
total_delete_errors:
anyOf:
- type: integer
- type: 'null'
title: Total Delete Errors
total_delete_success:
anyOf:
- type: integer
- type: 'null'
title: Total Delete Success
total_deleted:
anyOf:
- type: integer
- type: 'null'
title: Total Deleted
total_errors:
title: Total Errors
type: integer
total_public:
title: Total Public
type: integer
total_success:
title: Total Success
type: integer
required:
- batch_processing_status
- batch_release_status
- submission_date
- submission_name
- total_count
- total_errors
- total_public
- total_success
title: SummaryResponse
type: object
SummaryResponseDeletion-Input:
properties:
delete_date:
anyOf:
- type: string
- type: 'null'
title: Delete Date
delete_status:
anyOf:
- type: string
- type: 'null'
title: Delete Status
errors:
anyOf:
- items:
$ref: '#/components/schemas/SummaryResponseError-Input'
type: array
- type: 'null'
title: Errors
identifiers:
$ref: '#/components/schemas/SummaryResponseDeletionIdentifier'
processing_status:
title: Processing Status
type: string
required:
- identifiers
- processing_status
title: SummaryResponseDeletion
type: object
SummaryResponseDeletion-Output:
properties:
delete_date:
anyOf:
- type: string
- type: 'null'
title: Delete Date
delete_status:
anyOf:
- type: string
- type: 'null'
title: Delete Status
errors:
anyOf:
- items:
$ref: '#/components/schemas/SummaryResponseError-Output'
type: array
- type: 'null'
title: Errors
identifiers:
$ref: '#/components/schemas/SummaryResponseDeletionIdentifier'
processing_status:
title: Processing Status
type: string
required:
- identifiers
- processing_status
title: SummaryResponseDeletion
type: object
SummaryResponseDeletionIdentifier:
properties:
clinvar_accession:
title: Clinvar Accession
type: string
clinvar_local_key:
anyOf:
- type: string
- type: 'null'
title: Clinvar Local Key
required:
- clinvar_accession
title: SummaryResponseDeletionIdentifier
type: object
SummaryResponseError-Input:
properties:
input:
items:
$ref: '#/components/schemas/SummaryResponseErrorInput'
title: Input
type: array
output:
$ref: '#/components/schemas/SummaryResponseErrorOutput'
required:
- input
- output
title: SummaryResponseError
type: object
SummaryResponseError-Output:
properties:
input:
items:
$ref: '#/components/schemas/SummaryResponseErrorInput'
title: Input
type: array
output:
$ref: '#/components/schemas/SummaryResponseErrorOutput'
required:
- input
- output
title: SummaryResponseError
type: object
SummaryResponseErrorInput:
properties:
field:
anyOf:
- type: string
- type: 'null'
title: Field
value:
anyOf:
- type: string
- type: 'null'
title: Value
title: SummaryResponseErrorInput
type: object
SummaryResponseErrorOutput:
properties:
errors:
items:
$ref: '#/components/schemas/SummaryResponseErrorOutputError'
title: Errors
type: array
required:
- errors
title: SummaryResponseErrorOutput
type: object
SummaryResponseErrorOutputError:
properties:
user_message:
title: User Message
type: string
required:
- user_message
title: SummaryResponseErrorOutputError
type: object
SummaryResponseSubmission-Input:
properties:
clinvar_accession_version:
anyOf:
- type: string
- type: 'null'
title: Clinvar Accession Version
errors:
anyOf:
- items:
$ref: '#/components/schemas/SummaryResponseError-Input'
type: array
- type: 'null'
title: Errors
identifiers:
$ref: '#/components/schemas/SummaryResponseSubmissionIdentifiers'
processing_status:
title: Processing Status
type: string
release_date:
anyOf:
- type: string
- type: 'null'
title: Release Date
release_status:
anyOf:
- type: string
- type: 'null'
title: Release Status
required:
- identifiers
- processing_status
title: SummaryResponseSubmission
type: object
SummaryResponseSubmission-Output:
properties:
clinvar_accession_version:
anyOf:
- type: string
- type: 'null'
title: Clinvar Accession Version
errors:
anyOf:
- items:
$ref: '#/components/schemas/SummaryResponseError-Output'
type: array
- type: 'null'
title: Errors
identifiers:
$ref: '#/components/schemas/SummaryResponseSubmissionIdentifiers'
processing_status:
title: Processing Status
type: string
release_date:
anyOf:
- type: string
- type: 'null'
title: Release Date
release_status:
anyOf:
- type: string
- type: 'null'
title: Release Status
required:
- identifiers
- processing_status
title: SummaryResponseSubmission
type: object
SummaryResponseSubmissionIdentifiers:
properties:
clinvar_accession:
anyOf:
- type: string
- type: 'null'
title: Clinvar Accession
clinvar_local_key:
title: Clinvar Local Key
type: string
local_id:
anyOf:
- type: string
- type: 'null'
title: Local Id
local_key:
anyOf:
- type: string
- type: 'null'
title: Local Key
required:
- clinvar_local_key
title: SummaryResponseSubmissionIdentifiers
type: object
TotalCursorPage_SubmissionActivityRead_:
properties:
current_page:
anyOf:
- type: string
- type: 'null'
description: Cursor to refetch the current page
title: Current Page
current_page_backwards:
anyOf:
- type: string
- type: 'null'
description: Cursor to refetch the current page starting from the last item
title: Current Page Backwards
items:
items:
$ref: '#/components/schemas/SubmissionActivityRead'
title: Items
type: array
next_page:
anyOf:
- type: string
- type: 'null'
description: Cursor for the next page
title: Next Page
previous_page:
anyOf:
- type: string
- type: 'null'
description: Cursor for the previous page
title: Previous Page
total:
anyOf:
- type: integer
- type: 'null'
description: Total items
title: Total
required:
- items
title: TotalCursorPage[SubmissionActivityRead]
type: object
TotalCursorPage_SubmissionThreadRead_:
properties:
current_page:
anyOf:
- type: string
- type: 'null'
description: Cursor to refetch the current page
title: Current Page
current_page_backwards:
anyOf:
- type: string
- type: 'null'
description: Cursor to refetch the current page starting from the last item
title: Current Page Backwards
items:
items:
$ref: '#/components/schemas/SubmissionThreadRead'
title: Items
type: array
next_page:
anyOf:
- type: string
- type: 'null'
description: Cursor for the next page
title: Next Page
previous_page:
anyOf:
- type: string
- type: 'null'
description: Cursor for the previous page
title: Previous Page
total:
anyOf:
- type: integer
- type: 'null'
description: Total items
title: Total
required:
- items
title: TotalCursorPage[SubmissionThreadRead]
type: object
TotalCursorPage_SubmittingOrgRead_:
properties:
current_page:
anyOf:
- type: string
- type: 'null'
description: Cursor to refetch the current page
title: Current Page
current_page_backwards:
anyOf:
- type: string
- type: 'null'
description: Cursor to refetch the current page starting from the last item
title: Current Page Backwards
items:
items:
$ref: '#/components/schemas/SubmittingOrgRead'
title: Items
type: array
next_page:
anyOf:
- type: string
- type: 'null'
description: Cursor for the next page
title: Next Page
previous_page:
anyOf:
- type: string
- type: 'null'
description: Cursor for the previous page
title: Previous Page
total:
anyOf:
- type: integer
- type: 'null'
description: Total items
title: Total
required:
- items
title: TotalCursorPage[SubmittingOrgRead]
type: object
UserRead:
description: 'Model to use for reading users.
We expose the public OAuth account information.'
properties:
email:
format: email
title: Email
type: string
id:
format: uuid
title: Id
type: string
is_active:
default: true
title: Is Active
type: boolean
is_superuser:
default: false
title: Is Superuser
type: boolean
is_verified:
default: false
title: Is Verified
type: boolean
oauth_accounts:
default: []
items:
$ref: '#/components/schemas/PublicOAuthAccount'
title: Oauth Accounts
type: array
required:
- id
- email
title: UserRead
type: object
UserUpdate:
description: 'Model to use for updateing users.
We expose the public OAuth account information.'
properties:
email:
anyOf:
- format: email
type: string
- type: 'null'
title: Email
is_active:
anyOf:
- type: boolean
- type: 'null'
title: Is Active
is_superuser:
anyOf:
- type: boolean
- type: 'null'
title: Is Superuser
is_verified:
anyOf:
- type: boolean
- type: 'null'
title: Is Verified
oauth_accounts:
default: []
items:
$ref: '#/components/schemas/PublicOAuthAccount'
title: Oauth Accounts
type: array
password:
anyOf:
- type: string
- type: 'null'
title: Password
title: UserUpdate
type: object
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
title: Location
type: array
msg:
title: Message
type: string
type:
title: Error Type
type: string
required:
- loc
- msg
- type
title: ValidationError
type: object
VariantPresence:
description: Status of a variant in ClinVar.
enum:
- absent
- present
title: VariantPresence
type: string
VariantType:
enum:
- Insertion
- Deletion
- Duplication
- Tandem duplication
- copy number loss
- copy number gain
- Inversion
- Translocation
- Complex
title: VariantType
type: string
Zygosity:
enum:
- GENO:0000135
- NCIT:C45826
- NCIT:C198518
- reev:unknown_zygosity
title: Zygosity
type: string
securitySchemes:
APIKeyCookie:
in: cookie
name: fastapiusersauth
type: apiKey
OAuth2PasswordBearer:
flows:
password:
scopes: {}
tokenUrl: /api/v1/auth/login
type: oauth2
info:
title: REEV
version: 0.1.0
openapi: 3.1.0
paths:
/api/v1/acmgseqvar/create:
post:
description: 'Create a new ACMG Sequence Variant.
:param acmgseqvar: ACMG Sequence Variant to create
:type acmgseqvar: dict or :class:`.schemas.AcmgSeqVarCreate`
:return: ACMG Sequence Variant
:rtype: dict'
operationId: create_acmgseqvar_api_v1_acmgseqvar_create_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AcmgSeqVarCreate-Input'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AcmgSeqVarCreate-Output'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Create Acmgseqvar
tags:
- acmgseqvar
/api/v1/acmgseqvar/delete:
delete:
description: 'Delete a ACMG Sequence Variant by id.
:param id: ACMG Sequence Variant id
:type id: uuid
:return: ACMG Sequence Variant
:rtype: dict'
operationId: delete_acmgseqvar_by_user_api_v1_acmgseqvar_delete_delete
parameters:
- in: query
name: seqvar
required: true
schema:
title: Seqvar
type: string
- in: header
name: user-agent
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: User-Agent
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AcmgSeqVarRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Delete Acmgseqvar By User
tags:
- acmgseqvar
/api/v1/acmgseqvar/delete-by-id:
delete:
description: 'Delete a ACMG Sequence Variant by id. Available only for superusers.
:param id: ACMG Sequence Variant id
:type id: uuid
:return: ACMG Sequence Variant
:rtype: dict'
operationId: delete_acmgseqvar_api_v1_acmgseqvar_delete_by_id_delete
parameters:
- in: query
name: id
required: true
schema:
title: Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AcmgSeqVarRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Delete Acmgseqvar
tags:
- acmgseqvar
/api/v1/acmgseqvar/get:
get:
description: 'Get a ACMG Sequence Variant by id.
:param id: ACMG Sequence Variant id
:type id: uuid
:return: ACMG Sequence Variant
:rtype: dict
:raises HTTPException 404: ACMG Sequence Variant not found
:note: If user_agent is browser, return 204 Response'
operationId: get_acmgseqvar_by_user_api_v1_acmgseqvar_get_get
parameters:
- in: query
name: seqvar
required: true
schema:
title: Seqvar
type: string
- in: header
name: user-agent
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: User-Agent
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AcmgSeqVarRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Get Acmgseqvar By User
tags:
- acmgseqvar
/api/v1/acmgseqvar/get-by-id:
get:
description: 'Get a ACMG Sequence Variant by id. Available only for superusers.
:param id: ACMG Sequence Variant id
:type id: uuid
:return: ACMG Sequence Variant
:rtype: dict'
operationId: get_acmgseqvar_api_v1_acmgseqvar_get_by_id_get
parameters:
- in: query
name: id
required: true
schema:
title: Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AcmgSeqVarRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Get Acmgseqvar
tags:
- acmgseqvar
/api/v1/acmgseqvar/list:
get:
description: 'List ACMG Sequence Variants by user.
:return: list of ACMG Sequence Variants
:rtype: list'
operationId: list_acmgseqvars_by_user_api_v1_acmgseqvar_list_get
parameters:
- in: query
name: skip
required: false
schema:
default: 0
title: Skip
type: integer
- in: query
name: limit
required: false
schema:
default: 100
title: Limit
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AcmgSeqVarRead'
title: Response List Acmgseqvars By User Api V1 Acmgseqvar List Get
type: array
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: List Acmgseqvars By User
tags:
- acmgseqvar
/api/v1/acmgseqvar/list-all:
get:
description: 'List all ACMG Sequence Variants. Available only for superusers.
:param skip: number of ACMG Sequence Variants to skip
:type skip: int
:param limit: maximum number of ACMG Sequence Variants to return
:type limit: int
:return: list of ACMG Sequence Variants
:rtype: list'
operationId: list_acmgseqvars_api_v1_acmgseqvar_list_all_get
parameters:
- in: query
name: skip
required: false
schema:
default: 0
title: Skip
type: integer
- in: query
name: limit
required: false
schema:
default: 100
title: Limit
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AcmgSeqVarRead'
title: Response List Acmgseqvars Api V1 Acmgseqvar List All Get
type: array
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: List Acmgseqvars
tags:
- acmgseqvar
/api/v1/acmgseqvar/update:
patch:
description: 'Update a ACMG Sequence Variant.
:param acmgseqvar: ACMG Sequence Variant to update
:type acmgseqvar: dict or :class:`.schemas.AcmgSeqVarUpdate`
:return: ACMG Sequence Variant
:rtype: dict'
operationId: update_acmgseqvar_api_v1_acmgseqvar_update_patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AcmgSeqVarUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AcmgSeqVarRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Update Acmgseqvar
tags:
- acmgseqvar
put:
description: 'Update a ACMG Sequence Variant.
:param acmgseqvar: ACMG Sequence Variant to update
:type acmgseqvar: dict or :class:`.schemas.AcmgSeqVarUpdate`
:return: ACMG Sequence Variant
:rtype: dict'
operationId: update_acmgseqvar_api_v1_acmgseqvar_update_put
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/AcmgSeqVarUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AcmgSeqVarRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Update Acmgseqvar
tags:
- acmgseqvar
/api/v1/adminmsgs/:
get:
description: 'Retrieve all admin messages.
:return: list of admin messages
:rtype: list'
operationId: read_adminmsgs_api_v1_adminmsgs__get
parameters:
- in: query
name: skip
required: false
schema:
default: 0
title: Skip
type: integer
- in: query
name: limit
required: false
schema:
default: 100
title: Limit
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/AdminMessageRead'
title: Response Read Adminmsgs Api V1 Adminmsgs Get
type: array
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Read Adminmsgs
tags:
- adminmsgs
/api/v1/auth/bearer/login:
post:
operationId: auth_bearer_login_api_v1_auth_bearer_login_post
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Body_auth_bearer_login_api_v1_auth_bearer_login_post'
required: true
responses:
'200':
content:
application/json:
example:
access_token: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjoiOTIyMWZmYzktNjQwZi00MzcyLTg2ZDMtY2U2NDJjYmE1NjAzIiwiYXVkIjoiZmFzdGFwaS11c2VyczphdXRoIiwiZXhwIjoxNTcxNTA0MTkzfQ.M10bjOe45I5Ncu_uXvOmVV8QxnL-nZfcH96U90JaocI
token_type: bearer
schema:
$ref: '#/components/schemas/BearerResponse'
description: Successful Response
'400':
content:
application/json:
examples:
LOGIN_BAD_CREDENTIALS:
summary: Bad credentials or the user is inactive.
value:
detail: LOGIN_BAD_CREDENTIALS
LOGIN_USER_NOT_VERIFIED:
summary: The user is not verified.
value:
detail: LOGIN_USER_NOT_VERIFIED
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Auth:Bearer.Login
tags:
- auth
/api/v1/auth/bearer/logout:
post:
operationId: auth_bearer_logout_api_v1_auth_bearer_logout_post
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'401':
description: Missing token or inactive user.
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Auth:Bearer.Logout
tags:
- auth
/api/v1/auth/cookie/login:
post:
operationId: auth_cookie_login_api_v1_auth_cookie_login_post
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Body_auth_cookie_login_api_v1_auth_cookie_login_post'
required: true
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'204':
description: No Content
'400':
content:
application/json:
examples:
LOGIN_BAD_CREDENTIALS:
summary: Bad credentials or the user is inactive.
value:
detail: LOGIN_BAD_CREDENTIALS
LOGIN_USER_NOT_VERIFIED:
summary: The user is not verified.
value:
detail: LOGIN_USER_NOT_VERIFIED
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Auth:Cookie.Login
tags:
- auth
/api/v1/auth/cookie/logout:
post:
operationId: auth_cookie_logout_api_v1_auth_cookie_logout_post
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'204':
description: No Content
'401':
description: Missing token or inactive user.
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Auth:Cookie.Logout
tags:
- auth
/api/v1/auth/oauth2-providers:
get:
description: 'Retrieve all admin messages.
:return: list of admin messages
:rtype: list'
operationId: list_oauth2_providers_api_v1_auth_oauth2_providers_get
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/OAuth2ProviderPublic'
title: Response List Oauth2 Providers Api V1 Auth Oauth2 Providers
Get
type: array
description: Successful Response
summary: List Oauth2 Providers
tags:
- auth
/api/v1/auth/request-verify-token:
post:
operationId: verify_request_token_api_v1_auth_request_verify_token_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_verify_request_token_api_v1_auth_request_verify_token_post'
required: true
responses:
'202':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Verify:Request-Token
tags:
- auth
/api/v1/auth/verify:
post:
operationId: verify_verify_api_v1_auth_verify_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/Body_verify_verify_api_v1_auth_verify_post'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserRead'
description: Successful Response
'400':
content:
application/json:
examples:
VERIFY_USER_ALREADY_VERIFIED:
summary: The user is already verified.
value:
detail: VERIFY_USER_ALREADY_VERIFIED
VERIFY_USER_BAD_TOKEN:
summary: Bad token, not existing user ornot the e-mail currently
set for the user.
value:
detail: VERIFY_USER_BAD_TOKEN
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Verify:Verify
tags:
- auth
/api/v1/bookmarks/create:
post:
description: 'Create a new bookmark.
:param bookmark: bookmark to create
:type bookmark: dict or :class:`.schemas.BookmarkCreate`
:return: bookmark
:rtype: dict'
operationId: create_bookmark_api_v1_bookmarks_create_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/BookmarkCreate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BookmarkCreate'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Create Bookmark
tags:
- bookmarks
/api/v1/bookmarks/delete:
delete:
description: 'Delete a bookmark for a current user by obj_type and obj_id.
:param obj_type: type of object to bookmark
:type obj_type: str (enum) - "gene", "seqvar", "strucvar"
:param obj_id: id of object to bookmark
:type obj_id: uuid
:return: bookmark which was deleted
:rtype: dict
:raises HTTPException 404: if bookmark not found
:note: if user_agent is browser, return 204 Response'
operationId: delete_bookmark_for_user_api_v1_bookmarks_delete_delete
parameters:
- in: query
name: obj_type
required: true
schema:
title: Obj Type
type: string
- in: query
name: obj_id
required: true
schema:
title: Obj Id
type: string
- in: header
name: user-agent
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: User-Agent
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BookmarkRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Delete Bookmark For User
tags:
- bookmarks
/api/v1/bookmarks/delete-by-id:
delete:
description: 'Delete a bookmark. Available for superusers and bookmark owners.
:param id: id of the bookmark
:type id: uuid
:return: bookmark which was deleted
:rtype: dict'
operationId: delete_bookmark_api_v1_bookmarks_delete_by_id_delete
parameters:
- in: query
name: id
required: true
schema:
title: Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BookmarkRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Delete Bookmark
tags:
- bookmarks
/api/v1/bookmarks/get:
get:
description: 'Get a bookmark for a current user by obj_type and obj_id.
:param obj_type: type of object to bookmark
:type obj_type: str (enum) - "gene", "seqvar", "strucvar"
:param obj_id: id of object to bookmark
:type obj_id: uuid
:return: bookmark
:rtype: dict
:raises HTTPException 404: if bookmark not found
:note: if user_agent is browser, return 204'
operationId: get_bookmark_for_user_api_v1_bookmarks_get_get
parameters:
- in: query
name: obj_type
required: true
schema:
title: Obj Type
type: string
- in: query
name: obj_id
required: true
schema:
title: Obj Id
type: string
- in: header
name: user-agent
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: User-Agent
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BookmarkRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Get Bookmark For User
tags:
- bookmarks
/api/v1/bookmarks/get-by-id:
get:
description: 'Get a bookmark by id. Available only for superusers.
:param id: id of the bookmark
:type id: uuid
:return: bookmark
:rtype: dict'
operationId: get_bookmark_api_v1_bookmarks_get_by_id_get
parameters:
- in: query
name: id
required: true
schema:
title: Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/BookmarkRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Get Bookmark
tags:
- bookmarks
/api/v1/bookmarks/list:
get:
description: 'List bookmarks for a current user.
:param skip: number of bookmarks to skip
:type skip: int
:param limit: maximum number of bookmarks to return
:type limit: int
:return: list of bookmarks
:rtype: list'
operationId: list_bookmarks_for_user_api_v1_bookmarks_list_get
parameters:
- in: query
name: skip
required: false
schema:
default: 0
title: Skip
type: integer
- in: query
name: limit
required: false
schema:
default: 100
title: Limit
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/BookmarkRead'
title: Response List Bookmarks For User Api V1 Bookmarks List Get
type: array
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: List Bookmarks For User
tags:
- bookmarks
/api/v1/bookmarks/list-all:
get:
description: 'List all bookmarks. Available only for superusers.
:param skip: number of bookmarks to skip
:type skip: int
:param limit: maximum number of bookmarks to return
:type limit: int
:return: list of bookmarks
:rtype: list'
operationId: list_bookmarks_api_v1_bookmarks_list_all_get
parameters:
- in: query
name: skip
required: false
schema:
default: 0
title: Skip
type: integer
- in: query
name: limit
required: false
schema:
default: 100
title: Limit
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/BookmarkRead'
title: Response List Bookmarks Api V1 Bookmarks List All Get
type: array
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: List Bookmarks
tags:
- bookmarks
/api/v1/caseinfo/create:
post:
description: 'Create a new Case Information.
:param caseinfo: Case Information to create
:type caseinfo: dict or :class:`.schemas.CaseInfoCreate`
:return: Case Information
:rtype: dict'
operationId: create_caseinfo_api_v1_caseinfo_create_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInfoCreate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInfoCreate'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Create Caseinfo
tags:
- caseinfo
/api/v1/caseinfo/delete:
delete:
description: 'Delete a Case Information for a current user.
:return: Case Information
:rtype: dict'
operationId: delete_caseinfo_for_user_api_v1_caseinfo_delete_delete
parameters:
- in: header
name: user-agent
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: User-Agent
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInfoRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Delete Caseinfo For User
tags:
- caseinfo
/api/v1/caseinfo/delete-by-id:
delete:
description: 'Delete a Case Information by id. Available only for superusers.
:param id: Case Information id
:type id: uuid
:return: Case Information
:rtype: dict'
operationId: delete_caseinfo_api_v1_caseinfo_delete_by_id_delete
parameters:
- in: query
name: id
required: true
schema:
title: Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInfoRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Delete Caseinfo
tags:
- caseinfo
/api/v1/caseinfo/get:
get:
description: 'Get a Case Information for a current user.
:return: Case Information
:rtype: dict'
operationId: get_caseinfo_for_user_api_v1_caseinfo_get_get
parameters:
- in: header
name: user-agent
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: User-Agent
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInfoRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Get Caseinfo For User
tags:
- caseinfo
/api/v1/caseinfo/get-by-id:
get:
description: 'Get a Case Information by id. Available only for superusers.
:param id: Case Information id
:type id: uuid
:return: Case Information
:rtype: dict'
operationId: get_caseinfo_api_v1_caseinfo_get_by_id_get
parameters:
- in: query
name: id
required: true
schema:
title: Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInfoRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Get Caseinfo
tags:
- caseinfo
/api/v1/caseinfo/list:
get:
description: 'List all Case Information for a current user.
:return: list of Case Information
:rtype: list'
operationId: list_caseinfos_for_user_api_v1_caseinfo_list_get
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CaseInfoRead'
title: Response List Caseinfos For User Api V1 Caseinfo List Get
type: array
description: Successful Response
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: List Caseinfos For User
tags:
- caseinfo
/api/v1/caseinfo/list-all:
get:
description: 'List all Case Information. Available only for superusers.
:param skip: number of Case Information to skip
:type skip: int
:param limit: maximum number of Case Information to return
:type limit: int
:return: list of Case Information
:rtype: list'
operationId: list_caseinfos_api_v1_caseinfo_list_all_get
parameters:
- in: query
name: skip
required: false
schema:
default: 0
title: Skip
type: integer
- in: query
name: limit
required: false
schema:
default: 100
title: Limit
type: integer
responses:
'200':
content:
application/json:
schema:
items:
$ref: '#/components/schemas/CaseInfoRead'
title: Response List Caseinfos Api V1 Caseinfo List All Get
type: array
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: List Caseinfos
tags:
- caseinfo
/api/v1/caseinfo/update:
patch:
description: 'Update a Case Information for a current user.
:param caseinfo: Case Information to update
:type caseinfo: dict or :class:`.schemas.CaseInfoUpdate`
:return: Case Information
:rtype: dict'
operationId: update_caseinfo_for_user_api_v1_caseinfo_update_patch
parameters:
- in: header
name: user-agent
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: User-Agent
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInfoUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInfoRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Update Caseinfo For User
tags:
- caseinfo
put:
description: 'Update a Case Information for a current user.
:param caseinfo: Case Information to update
:type caseinfo: dict or :class:`.schemas.CaseInfoUpdate`
:return: Case Information
:rtype: dict'
operationId: update_caseinfo_for_user_api_v1_caseinfo_update_put
parameters:
- in: header
name: user-agent
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: User-Agent
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInfoUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/CaseInfoRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Update Caseinfo For User
tags:
- caseinfo
/api/v1/clinvarsub/submissionactivities/{submissionactivity_id}:
put:
description: 'Create a new submission activity in the given thread.
:param submissionthread_id: Submission thread UUID.
:return: Created submission activity.'
operationId: update_submissionactivity_api_v1_clinvarsub_submissionactivities__submissionactivity_id__put
parameters:
- in: path
name: submissionactivity_id
required: true
schema:
title: Submissionactivity Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionActivityUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionActivityRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Update Submissionactivity
tags:
- clinvarsub
/api/v1/clinvarsub/submissionthreads:
get:
description: 'List submission threads of current user in paginated fashion.
:return: Paginated list of results.'
operationId: list_submissionthreads_api_v1_clinvarsub_submissionthreads_get
parameters:
- in: query
name: primary_variant_desc
required: false
schema:
anyOf:
- type: string
- type: 'null'
title: Primary Variant Desc
- description: Cursor for the next page
in: query
name: cursor
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Cursor for the next page
title: Cursor
- description: Page size
in: query
name: size
required: false
schema:
default: 50
description: Page size
maximum: 100
minimum: 0
title: Size
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TotalCursorPage_SubmissionThreadRead_'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: List Submissionthreads
tags:
- clinvarsub
post:
description: 'Create a new submission thread.
:param submissionthread: Data of submission thread to create.
:return: Created submission thread.'
operationId: create_submissionthread_api_v1_clinvarsub_submissionthreads_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionThreadCreate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionThreadRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Create Submissionthread
tags:
- clinvarsub
/api/v1/clinvarsub/submissionthreads/{submissionthread_id}:
delete:
description: 'Update submission thread (current user must be owner).
:return: Paginated list of results.'
operationId: delete_submissionthread_api_v1_clinvarsub_submissionthreads__submissionthread_id__delete
parameters:
- in: path
name: submissionthread_id
required: true
schema:
title: Submissionthread Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionThreadRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Delete Submissionthread
tags:
- clinvarsub
get:
description: 'Retrieve submission thread (current user must be owner).
:param id: Submission thread UUID.
:return: Submission tread data.'
operationId: get_submissionthread_by_id_api_v1_clinvarsub_submissionthreads__submissionthread_id__get
parameters:
- in: path
name: submissionthread_id
required: true
schema:
title: Submissionthread Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionThreadRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Get Submissionthread By Id
tags:
- clinvarsub
put:
description: 'Update submission thread (current user must be owner).
:param id: Submission thread UUID.
:return: Submission tread data.'
operationId: update_submissionthread_api_v1_clinvarsub_submissionthreads__submissionthread_id__put
parameters:
- in: path
name: submissionthread_id
required: true
schema:
title: Submissionthread Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionThreadUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionThreadRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Update Submissionthread
tags:
- clinvarsub
/api/v1/clinvarsub/submissionthreads/{submissionthread_id}/activities:
get:
description: 'List submission activities of given submission thread.
Current user must be owner.
:param submissionthread_id: Submission thread UUID.
:return: Paginated list of results.'
operationId: list_submissionactivities_api_v1_clinvarsub_submissionthreads__submissionthread_id__activities_get
parameters:
- in: path
name: submissionthread_id
required: true
schema:
title: Submissionthread Id
type: string
- description: Cursor for the next page
in: query
name: cursor
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Cursor for the next page
title: Cursor
- description: Page size
in: query
name: size
required: false
schema:
default: 50
description: Page size
maximum: 100
minimum: 0
title: Size
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TotalCursorPage_SubmissionActivityRead_'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: List Submissionactivities
tags:
- clinvarsub
post:
description: 'Create a new submission activity in the given thread.
:param submissionthread_id: Submission thread UUID.
:return: Created submission activity.'
operationId: create_submissionactivity_api_v1_clinvarsub_submissionthreads__submissionthread_id__activities_post
parameters:
- in: path
name: submissionthread_id
required: true
schema:
title: Submissionthread Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionActivityCreate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmissionActivityRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Create Submissionactivity
tags:
- clinvarsub
/api/v1/clinvarsub/submittingorgs:
get:
description: 'List submitting orgs of current user in paginated fashion.
:return: Paginated list of results.'
operationId: list_submittingorgs_api_v1_clinvarsub_submittingorgs_get
parameters:
- description: Cursor for the next page
in: query
name: cursor
required: false
schema:
anyOf:
- type: string
- type: 'null'
description: Cursor for the next page
title: Cursor
- description: Page size
in: query
name: size
required: false
schema:
default: 50
description: Page size
maximum: 100
minimum: 0
title: Size
type: integer
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/TotalCursorPage_SubmittingOrgRead_'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: List Submittingorgs
tags:
- clinvarsub
post:
description: 'Create a new submitting org.
:param submittingorg: Data of submitting org to create.
:return: Created submitting org.'
operationId: create_submittingorg_api_v1_clinvarsub_submittingorgs_post
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubmittingOrgCreate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmittingOrgRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Create Submittingorg
tags:
- clinvarsub
/api/v1/clinvarsub/submittingorgs/{submittingorg_id}:
delete:
description: 'Update submitting org (current user must be owner).
:return: Paginated list of results.'
operationId: delete_submittingorg_api_v1_clinvarsub_submittingorgs__submittingorg_id__delete
parameters:
- in: path
name: submittingorg_id
required: true
schema:
title: Submittingorg Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmittingOrgRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Delete Submittingorg
tags:
- clinvarsub
get:
description: 'Retrieve submitting org (current user must be owner).
:param id: Submitting org UUID.
:return: Submitting org data.'
operationId: get_submittingorg_by_id_api_v1_clinvarsub_submittingorgs__submittingorg_id__get
parameters:
- in: path
name: submittingorg_id
required: true
schema:
title: Submittingorg Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmittingOrgRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Get Submittingorg By Id
tags:
- clinvarsub
put:
description: 'Update submitting org (current user must be owner).
:return: Paginated list of results.'
operationId: update_submittingorg_api_v1_clinvarsub_submittingorgs__submittingorg_id__put
parameters:
- in: path
name: submittingorg_id
required: true
schema:
title: Submittingorg Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/SubmittingOrgUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/SubmittingOrgRead'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Update Submittingorg
tags:
- clinvarsub
/api/v1/users/me:
get:
operationId: users_current_user_api_v1_users_me_get
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserRead'
description: Successful Response
'401':
description: Missing token or inactive user.
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Users:Current User
tags:
- users
patch:
operationId: users_patch_current_user_api_v1_users_me_patch
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserRead'
description: Successful Response
'400':
content:
application/json:
examples:
UPDATE_USER_EMAIL_ALREADY_EXISTS:
summary: A user with this email already exists.
value:
detail: UPDATE_USER_EMAIL_ALREADY_EXISTS
UPDATE_USER_INVALID_PASSWORD:
summary: Password validation failed.
value:
detail:
code: UPDATE_USER_INVALID_PASSWORD
reason: Password should beat least 3 characters
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'401':
description: Missing token or inactive user.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Users:Patch Current User
tags:
- users
/api/v1/users/{id}:
delete:
operationId: users_delete_user_api_v1_users__id__delete
parameters:
- in: path
name: id
required: true
schema:
title: Id
type: string
responses:
'204':
description: Successful Response
'401':
description: Missing token or inactive user.
'403':
description: Not a superuser.
'404':
description: The user does not exist.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Users:Delete User
tags:
- users
get:
operationId: users_user_api_v1_users__id__get
parameters:
- in: path
name: id
required: true
schema:
title: Id
type: string
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserRead'
description: Successful Response
'401':
description: Missing token or inactive user.
'403':
description: Not a superuser.
'404':
description: The user does not exist.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Users:User
tags:
- users
patch:
operationId: users_patch_user_api_v1_users__id__patch
parameters:
- in: path
name: id
required: true
schema:
title: Id
type: string
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UserUpdate'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/UserRead'
description: Successful Response
'400':
content:
application/json:
examples:
UPDATE_USER_EMAIL_ALREADY_EXISTS:
summary: A user with this email already exists.
value:
detail: UPDATE_USER_EMAIL_ALREADY_EXISTS
UPDATE_USER_INVALID_PASSWORD:
summary: Password validation failed.
value:
detail:
code: UPDATE_USER_INVALID_PASSWORD
reason: Password should beat least 3 characters
schema:
$ref: '#/components/schemas/ErrorModel'
description: Bad Request
'401':
description: Missing token or inactive user.
'403':
description: Not a superuser.
'404':
description: The user does not exist.
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Users:Patch User
tags:
- users
/api/v1/utils/test-email/:
post:
description: 'Send out a test email.
:param email_to: email address to send the test email to
:type email_to: str
:return: message
:rtype: dict'
operationId: test_email_api_v1_utils_test_email__post
parameters:
- in: query
name: email_to
required: true
schema:
format: email
title: Email To
type: string
responses:
'201':
content:
application/json:
schema:
$ref: '#/components/schemas/Msg'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
- APIKeyCookie: []
summary: Test Email
tags:
- utils
/internal/data-versions:
get:
description: 'Return versions of data and services used in the application.
:return: A JSON response containing the versions of various data and services.
:rtype: dict'
operationId: data_versions_internal_data_versions_get
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Data Versions
post:
description: 'Return versions of data and services used in the application.
:return: A JSON response containing the versions of various data and services.
:rtype: dict'
operationId: data_versions_internal_data_versions_post
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Data Versions
/internal/frontend-settings:
get:
description: 'Return frontend settings.
:return: frontend settings
:rtype: dict'
operationId: frontend_settings_internal_frontend_settings_get
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Frontend Settings
post:
description: 'Return frontend settings.
:return: frontend settings
:rtype: dict'
operationId: frontend_settings_internal_frontend_settings_post
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Frontend Settings
/internal/proxy/{path}:
get:
description: 'Reverse proxy to internal services.
Supported services:
- AnnoNARS
- MeHARI
- Viguno
- NGINX
- Dotty
- CADA-Prio
- AutoACMG
:param request: request
:type request: :class:`fastapi.Request`
:return: response
:rtype: :class:`fastapi.Response`'
operationId: reverse_proxy_internal_proxy__path__get
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Reverse Proxy
tags:
- proxy
post:
description: 'Reverse proxy to internal services.
Supported services:
- AnnoNARS
- MeHARI
- Viguno
- NGINX
- Dotty
- CADA-Prio
- AutoACMG
:param request: request
:type request: :class:`fastapi.Request`
:return: response
:rtype: :class:`fastapi.Response`'
operationId: reverse_proxy_internal_proxy__path__post
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Reverse Proxy
tags:
- proxy
/internal/remote/acmg/{path}:
get:
description: 'Implement searching for ACMG classification for SNVs and indels.
Proxy requests to the `WinterVar `_ backend.
:param request: request
:type request: :class:`fastapi.Request`
:return: ACMG classification
:rtype: dict'
operationId: acmg_internal_remote_acmg__path__get
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Acmg
tags:
- remote
/internal/remote/cnv/acmg/{path}:
get:
description: 'Implement searching for ACMG classification for CNVs.
Proxy requests to the `wAutoCNV `_ backend.
:param request: request
:type request: :class:`fastapi.Request`
:return: ACMG classification
:rtype: dict'
operationId: cnv_acmg_internal_remote_cnv_acmg__path__get
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Cnv Acmg
tags:
- remote
/internal/remote/pubtator3-api/{path}:
get:
description: 'Proxy requests to the `PubTator 3 `_
backend.
:param request: request
:type request: :class:`fastapi.Request`
:param path: path to append to the backend URL
:type path: str
:return: response
:rtype: :class:`fastapi.responses.StreamingResponse`'
operationId: pubtator3_api_internal_remote_pubtator3_api__path__get
parameters:
- in: path
name: path
required: true
schema:
title: Path
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Pubtator3 Api
tags:
- remote
/internal/remote/variantvalidator/{path}:
get:
description: 'Implement VariantValidator API. Proxy requests to the
`VariantValidator `_ backend.
:param request: request
:type request: :class:`fastapi.Request`
:param path: path to append to the backend URL
:type path: str
:return: response
:rtype: :class:`fastapi.responses.StreamingResponse`'
operationId: variantvalidator_internal_remote_variantvalidator__path__get
parameters:
- in: path
name: path
required: true
schema:
title: Path
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Variantvalidator
tags:
- remote
/internal/version:
get:
description: 'Return reev version.
:return: reev version
:rtype: str'
operationId: version_internal_version_get
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Version
post:
description: 'Return reev version.
:return: reev version
:rtype: str'
operationId: version_internal_version_post
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
summary: Version