diff --git a/Formats_rearrangement.yaml b/Formats_rearrangement.yaml new file mode 100644 index 0000000..de4dd99 --- /dev/null +++ b/Formats_rearrangement.yaml @@ -0,0 +1,211 @@ +# +# Schema definitions for AIRR Formats rearrangement objects +# + +# The Formats rearrangements +# Note: This is an extension of the MiAIRR rearrangements, and assumes that +# the MiAIRR has defined the MiAIRR rearrangement objects. +# required: +# - sequence_id +# - sequence +# - sample_id +# - constant +# - functional +# - rev_comp +# - c_call +# - v_score +# - d_score +# - j_score +# - c_score +# - v_cigar +# - d_cigar +# - j_cigar +# - c_cigar + + +Formats_Rearrangements: + discriminator: AIRRFormats + type: object + properties: + sequence_id: + type: string + description: Read/sequence identifier + sequence: + type: string + description: Nucleotide sequence (e.g., the "read" sequence; revcomp'd if + necessary) + sample_id: + type: string + description: The biological sample this read derives from (e.g., from BioSample + database) + constant: + type: string + description: Constant region gene (e.g., IGHG4, IGHA2, IGHE, TRBC) + functional: + type: boolean + description: VDJ sequence is predicted to be functional + rev_comp: + type: boolean + description: Sequence is reverse complemented + c_call: + type: string + description: C gene assignment + v_score: + type: number + description: V alignment score + d_score: + type: number + description: D alignment score + j_score: + type: number + description: J alignment score + c_score: + type: number + description: C alignment score + v_cigar: + type: string + description: V alignment CIGAR string + d_cigar: + type: string + description: D alignment CIGAR string + j_cigar: + type: string + description: J alignment CIGAR string + c_cigar: + type: string + description: C alignment CIGAR string + v_evalue: + type: number + description: V alignment E-value (when applicable) + d_evalue: + type: number + description: D alignment E-value (when applicable) + j_evalue: + type: number + description: J alignment E-value (when applicable) + v_identity: + type: number + description: V alignment identity + d_identity: + type: number + description: D alignment identity + j_identity: + type: number + description: J alignment identity + vdj_score: + type: number + description: Score for aligners that consider the full sequence as a whole + vdj_evalue: + type: number + description: E-value for aligners that consider the full sequence as a whole + vdj_identity: + type: number + description: Identity for aligners that consider the full sequence as a whole + vdj_cigar: + type: string + description: VDJ alignment CIGAR string + v_start: + type: integer + description: Position of first V nucleotide in 'sequence' field + v_germ_start: + type: integer + description: Position of 'v_start' field in IMGT numbered germline V(D)J sequence + fwr1_start: + type: integer + description: FWR1 start coordinate in sequence (transferred from germline) + fwr1_end: + type: integer + description: FWR1 end coordinate in sequence (transferred from germline) + cdr1_start: + type: integer + description: CDR1 start coord in sequence (transferred from germline) + cdr1_end: + type: integer + description: CDR1 end coord in sequence (transferred from germline) + fwr2_start: + type: integer + description: FWR2 start coord in sequence (transferred from germline) + fwr2_end: + type: integer + description: FWR2 end coord in sequence (transferred from germline) + cdr2_start: + type: integer + description: CDR2 start coord in sequence (transferred from germline) + cdr2_end: + type: integer + description: CDR2 end coord in sequence (transferred from germline) + fwr3_start: + type: integer + description: FWR3 start coord in sequence (transferred from germline) + fwr3_end: + type: integer + description: FWR3 end coord in sequence (transferred from germline) + cdr3_start: + type: integer + description: CDR3 start coord in sequence (transferred from germline) + cdr3_end: + type: integer + description: CDR3 end coord in sequence (transferred from germline) + fwr4_start: + type: integer + description: FWR3 start coord in sequence (transferred from germline) + fwr4_end: + type: integer + description: FWR4 end coord in sequence (transferred from germline) + v_end: + type: integer + description: End coordinate of the V segment (generally inside the CDR3) + d_start: + type: integer + description: Start coordinate of the D segment + d_germ_start: + type: integer + description: Position of 'd_start' field in IMGT numbered germline V(D)J sequence + d_end: + type: integer + description: End coordinate of the D segment + j_start: + type: integer + description: Start coordinate of the J segment (generally inside the CDR3) + j_germ_start: + type: integer + description: Position of 'j_start' field in IMGT numbered germline V(D)J sequence + j_end: + type: integer + description: End coordinate of the J segment + junction_length: + type: integer + description: Number of junction nucleotides in sequence_vdj + np1_length: + type: integer + description: Number of of nucleotides between sample V and D sequences + np2_length: + type: integer + description: Number of of nucleotides between sample D and J sequences + n1_length: + type: integer + description: Nucleotides 5' of the D-segment + n2_length: + type: integer + description: Nucleotides 3' of the D-segment + p3v_length: + type: integer + description: Palindromic nucleotides 3' of the V-segment + p5d_length: + type: integer + description: Palindromic nucleotides 5' of the D-segment + p3d_length: + type: integer + description: Palindromic nucleotides 3' of the D-segment + p5j_length: + type: integer + description: Palindromic nucleotides 5' of the J-segment + duplicate_count: + type: integer + description: Number of duplicate reads for this sequence + consensus_count: + type: integer + description: Number of reads contributing to the consensus for this sequence + clone: + type: string + description: Clone assignment for this sequence diff --git a/MiAIRR_rearrangement.yaml b/MiAIRR_rearrangement.yaml new file mode 100644 index 0000000..c24fa6b --- /dev/null +++ b/MiAIRR_rearrangement.yaml @@ -0,0 +1,50 @@ +# +# Schema definitions for AIRR minimal standards rearrangement objects +# + +# The MiAIRR rearrangements + +MiAIRR_Rearrangements: + discriminator: MiAIRR + type: object + properties: + germline_database: + type: string + description: > + Source of germline V(D)J segments, with version number or + date accessed (e.g. IMGT/V-QUEST Release 201736-4 (7 September 2017)) (AIRR) + cell_index: + type: integer + description: | + Cell Index (UID linking sequences from the same cell) (AIRR) + v_allele: + type: string + description: | + V gene with allele (e.g. IGHV4-59*01) (AIRR) + d_allele: + type: string + description: | + D gene with allele (e.g. IGHD3-10*01) (AIRR) + j_allele: + type: string + description: | + J gene with allele (e.g. IGHJ4*02) (AIRR) + c_allele: + type: string + description: | + C region with allele (AIRR) + junction_nt: + type: string + description: > + JUNCTION nucleotide sequence (Sequence of the CDR3 + region (nucleotide)) (AIRR) + junction_aa: + type: string + description: > + JUNCTION amino acid sequence (Sequence of the CDR3 + region (amino acid)) (AIRR) + duplicate_count: + type: integer + description: | + Number of times the sequence has been duplicated in a file (AIRR) + \ No newline at end of file diff --git a/README.md b/README.md index 6bb2742..5e26adb 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ JSON files are generated by Swagger editor. ## Development Guidelines -** Git Structure +### Git Structure * This project uses the Git Flow methodology for code management and development: . @@ -25,17 +25,17 @@ JSON files are generated by Swagger editor. double-check your branches and merge operations so the two versions do not get mixed up. - * The *v1-master* branch is the master branch for ongoing V1 API - work, with *v1-develop* as its develop branch. + * The **v1-master** branch is the master branch for ongoing V1 API + work, with **v1-develop** as its develop branch. - * The *master* branch is for ongoing V2 API work, with *develop* as + * The **master** branch is for ongoing V2 API work, with **develop** as its develop branch. * New development and features should be done on branches that are - cloned from the *develop* (for V2) or *v1-develop* (for V1) branch, + cloned from the **develop** (for V2) or **v1-develop** (for V1) branch, and then merged into this branch when completed. - * Releases should merge *develop* into *master* (for V2) or - *v1-develop* into *v1-master* (for V1). Tag *master* or *v1-master* - *with the appropriate version. + * Releases should merge **develop** into **master** (for V2) or + **v1-develop** into **v1-master** (for V1). Tag **master** or **v1-master** + with the appropriate version. diff --git a/iReceptor_Data_Service_API_V2.json b/iReceptor_Data_Service_API_V2.json index 1481731..7d12a8d 100644 --- a/iReceptor_Data_Service_API_V2.json +++ b/iReceptor_Data_Service_API_V2.json @@ -2,24 +2,681 @@ "swagger": "2.0", "info": { "title": "iReceptor Data Source API", - "version": "2.0.4", + "version": "2.0.5", "contact": { "name": "iReceptor Project", "url": "http://www.ireceptor.org/", "email": "breden@sfu.ca" }, - "description": "Documentation of Major Version 2 of the iReceptor Adaptive Immune Receptor Repertoire (AIRR) data source web service application programming interface (API). V2 of the API implements an increased level of compliance with the [Minimal Information for AIRR (MiAIRR) standard](https://github.com/airr-community/airr-standards). Learn more about [iReceptor](http://www.ireceptor.org/)\n" + "description": "Documentation of Major Version 2 of the iReceptor Adaptive Immune Receptor Repertoire (AIRR) data repsoitory web service application programming interface (API). V2 of the API implements an increased level of compliance with the [Minimal Information for AIRR (MiAIRR) standard](https://github.com/airr-community/airr-standards). Learn more about [iReceptor](http://www.ireceptor.org/)\n" }, "host": "ipa.ireceptor.org", "basePath": "/v2", + "definitions": { + "ireceptor_sample_summary_response": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/definitions/ireceptor_sequence_count_model" + }, + { + "$ref": "#/definitions/airr_summary_model" + }, + { + "$ref": "https://raw.githubusercontent.com/sfu-ireceptor/api/AIRR-compliance/ireceptor_summary.yaml#/ireceptor_summary_model" + } + ] + } + }, + "ireceptor_sequence_summary_response": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "#/definitions/ireceptor_sequence_count_model" + }, + { + "$ref": "#/definitions/ireceptor_filtered_sequence_count_model" + }, + { + "$ref": "#/definitions/airr_summary_model" + }, + { + "$ref": "https://raw.githubusercontent.com/sfu-ireceptor/api/AIRR-compliance/ireceptor_summary.yaml#/ireceptor_summary_model" + } + ] + } + }, + "ireceptor_sequence_response": { + "type": "array", + "items": { + "allOf": [ + { + "$ref": "https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/Rearrangement" + }, + { + "$ref": "https://raw.githubusercontent.com/sfu-ireceptor/api/AIRR-compliance/ireceptor_sequence.yaml#/ireceptor_sequence_annotation_model" + } + ] + } + }, + "airr_summary_model": { + "allOf": [ + { + "$ref": "https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/Study" + }, + { + "$ref": "https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/Subject" + }, + { + "$ref": "https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/Diagnosis" + }, + { + "$ref": "https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/Sample" + }, + { + "$ref": "https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/CellProcessing" + }, + { + "$ref": "https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/NucleicAcidProcessing" + }, + { + "$ref": "https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/RawSequenceData" + }, + { + "$ref": "https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/SoftwareProcessing" + } + ] + }, + "ireceptor_sequence_count_model": { + "type": "object", + "properties": { + "ir_sequence_count": { + "type": "integer", + "description": "Number of sequences found that met the sample search criteria for this sample", + "example": 123456 + } + } + }, + "ireceptor_filtered_sequence_count_model": { + "type": "object", + "properties": { + "ir_filtered_sequence_count": { + "type": "integer", + "description": "Number of sequences found that met the sequence search criteria for this sample", + "example": 4321 + } + } + }, + "ireceptor_core_samples_parameters_model": { + "type": "object", + "required": [ + "ir_username" + ], + "properties": { + "ir_username": { + "type": "string", + "description": "Username of the individual requesting access to the iReceptor repository node.\n" + }, + "ir_lab_id": { + "type": "string", + "description": "e.g. 1\n" + }, + "ir_project_id": { + "type": "array", + "items": { + "type": "string" + }, + "description": "e.g. 1\n" + } + } + }, + "ireceptor_ancillary_samples_parameters_model": { + "type": "object", + "properties": { + "ir_subject_age_min": { + "type": "integer", + "description": "e.g. 30\n" + }, + "ir_subject_age_max": { + "type": "integer", + "description": "e.g. 50\n" + } + } + }, + "airr_formats_sequences_parameters_model": { + "type": "object", + "properties": { + "junction_length": { + "type": "integer", + "description": "Number of junction nucleotides in sequence_vdj (CDR3 + conserved residues)\n" + }, + "junction_aa_length": { + "type": "integer", + "description": "Length of JUNCTION in amino acids" + }, + "functional": { + "type": "string", + "description": "Filter for sequences that are either functional, non-functional, or both\n" + } + } + }, + "ireceptor_core_sequences_parameters_model": { + "type": "object", + "required": [ + "ir_username" + ], + "properties": { + "ir_username": { + "type": "string", + "description": "Username of the individual requesting access to the iReceptor repository node.\n" + }, + "ir_project_sample_id_list": { + "type": "array", + "items": { + "type": "string" + } + }, + "ir_data_format": { + "description": "'csv' - vQuest based CSV (as per /v1); 'tsv' - vQuest based TSV (as per /v1 with tab delimiters instead of commas); 'airr' - AIRR Formats rearrangements TSV (as per AIRR formats rearrangements spec)" + } + } + }, + "ireceptor_ancillary_sequences_parameters_model": { + "type": "object", + "properties": { + "ir_show_unproductive": { + "type": "string", + "description": "By default, only productive sequences are returned. In order to return unproductive sequences, set this parameter to \"T\"" + } + } + } + }, + "parameters": { + "ir_username": { + "name": "ir_username", + "in": "query", + "description": "Username of the individual requesting access to the iReceptor repository node. If the iReceptor repository is a public repository, then this parameter is not required. If the repository is not public then the username must be supplied and the repository will determine the access for that user for that repository.\n", + "required": false, + "type": "string" + }, + "ir_username_form": { + "name": "ir_username", + "in": "formData", + "description": "Username of the individual requesting access to the iReceptor repository node. If the iReceptor repository is a public repository, then this parameter is not required. If the repository is not public then the username must be supplied and the repository will determine the access for that user for that repository.\n", + "required": false, + "type": "string" + }, + "study_id": { + "name": "study_id", + "type": "string", + "in": "query" + }, + "study_id_form": { + "name": "study_id", + "type": "string", + "in": "formData" + }, + "study_title": { + "name": "study_title", + "type": "string", + "in": "query" + }, + "study_title_form": { + "name": "study_title", + "type": "string", + "in": "formData" + }, + "study_description": { + "name": "study_description", + "type": "string", + "in": "query" + }, + "study_description_form": { + "name": "study_description", + "type": "string", + "in": "formData" + }, + "lab_name": { + "name": "lab_name", + "type": "string", + "in": "query" + }, + "lab_name_form": { + "name": "lab_name", + "type": "string", + "in": "formData" + }, + "subject_id": { + "name": "subject_id", + "type": "string", + "in": "query" + }, + "subject_id_form": { + "name": "subject_id", + "type": "string", + "in": "formData" + }, + "organism": { + "name": "organism", + "type": "string", + "in": "query" + }, + "organism_form": { + "name": "organism", + "type": "string", + "in": "formData" + }, + "sex": { + "name": "sex", + "type": "string", + "in": "query" + }, + "sex_form": { + "name": "sex", + "type": "string", + "in": "formData" + }, + "ethnicity": { + "name": "ethnicity", + "type": "array", + "items": { + "type": "string" + }, + "in": "query" + }, + "ethnicity_form": { + "name": "ethnicity", + "type": "array", + "items": { + "type": "string" + }, + "in": "formData" + }, + "study_group_description": { + "name": "study_group_description", + "type": "array", + "items": { + "type": "string" + }, + "in": "query" + }, + "study_group_description_form": { + "name": "study_group_description", + "type": "array", + "items": { + "type": "string" + }, + "in": "formData" + }, + "sample_id": { + "name": "sample_id", + "type": "string", + "in": "query" + }, + "sample_id_form": { + "name": "sample_id", + "type": "string", + "in": "formData" + }, + "tissue": { + "name": "tissue", + "type": "array", + "items": { + "type": "string" + }, + "in": "query" + }, + "tissue_form": { + "name": "tissue", + "type": "array", + "items": { + "type": "string" + }, + "in": "formData" + }, + "disease_state_sample": { + "name": "disease_state_sample", + "type": "string", + "in": "query" + }, + "disease_state_sample_form": { + "name": "disease_state_sample", + "type": "string", + "in": "formData" + }, + "cell_subset": { + "name": "cell_subset", + "type": "array", + "items": { + "type": "string" + }, + "in": "query" + }, + "cell_subset_form": { + "name": "cell_subset", + "type": "array", + "items": { + "type": "string" + }, + "in": "formData" + }, + "cell_phenotype": { + "name": "cell_phenotype", + "type": "string", + "in": "query" + }, + "cell_phenotype_form": { + "name": "cell_phenotype", + "type": "string", + "in": "formData" + }, + "template_class": { + "name": "template_class", + "type": "array", + "items": { + "type": "string" + }, + "in": "query" + }, + "template_class_form": { + "name": "template_class", + "type": "array", + "items": { + "type": "string" + }, + "in": "formData" + }, + "sequencing_platform": { + "name": "sequencing_platform", + "type": "string", + "in": "query" + }, + "sequencing_platform_form": { + "name": "sequencing_platform", + "type": "string", + "in": "formData" + }, + "ir_project_id": { + "name": "ir_project_id", + "in": "query", + "description": "e.g. 1\n", + "required": false, + "type": "array", + "items": { + "type": "string" + } + }, + "ir_project_id_form": { + "name": "ir_project_id", + "in": "formData", + "description": "e.g. 1\n", + "required": false, + "type": "array", + "items": { + "type": "string" + } + }, + "ir_subject_age_min": { + "name": "ir_subject_age_min", + "in": "query", + "description": "e.g. 10\n", + "required": false, + "type": "integer" + }, + "ir_subject_age_min_form": { + "name": "ir_subject_age_min", + "in": "formData", + "description": "e.g. 10\n", + "required": false, + "type": "integer" + }, + "ir_subject_age_max": { + "name": "ir_subject_age_max", + "in": "query", + "description": "e.g. 12\n", + "required": false, + "type": "integer" + }, + "ir_subject_age_max_form": { + "name": "ir_subject_age_max", + "in": "formData", + "description": "e.g. 12\n", + "required": false, + "type": "integer" + }, + "germline_database": { + "name": "germline_database", + "in": "query", + "type": "string", + "description": "Source of germline V(D)J segments, with version number or date accessed (e.g. IMGT/V-QUEST Release 201736-4 (7 September 2017)) (AIRR)\n" + }, + "germline_database_form": { + "name": "germline_database", + "in": "formData", + "type": "string", + "description": "Source of germline V(D)J segments, with version number or date accessed (e.g. IMGT/V-QUEST Release 201736-4 (7 September 2017)) (AIRR)\n" + }, + "cell_index": { + "name": "cell_index", + "in": "query", + "type": "integer", + "description": "Cell Index (UID linking sequences from the same cell) (AIRR)\n" + }, + "cell_index_form": { + "name": "cell_index", + "in": "formData", + "type": "integer", + "description": "Cell Index (UID linking sequences from the same cell) (AIRR)\n" + }, + "v_call": { + "name": "v_call", + "in": "query", + "type": "string", + "description": "V gene with allele (e.g. IGHV4-59*01) (AIRR)\n" + }, + "v_call_form": { + "name": "v_call", + "in": "formData", + "type": "string", + "description": "V gene with allele (e.g. IGHV4-59*01) (AIRR)\n" + }, + "d_call": { + "name": "d_call", + "in": "query", + "type": "string", + "description": "D gene with allele (e.g. IGHD3-10*01) (AIRR)\n" + }, + "d_call_form": { + "name": "d_call", + "in": "formData", + "type": "string", + "description": "D gene with allele (e.g. IGHD3-10*01) (AIRR)\n" + }, + "j_call": { + "name": "j_call", + "in": "query", + "type": "string", + "description": "J gene with allele (e.g. IGHJ4*02) (AIRR)\n" + }, + "j_call_form": { + "name": "j_call", + "in": "formData", + "type": "string", + "description": "J gene with allele (e.g. IGHJ4*02) (AIRR)\n" + }, + "c_call": { + "name": "c_call", + "in": "query", + "type": "string", + "description": "C region with allele (AIRR) \n" + }, + "c_call_form": { + "name": "c_call", + "in": "formData", + "type": "string", + "description": "C region with allele (AIRR) \n" + }, + "junction_nt": { + "name": "junction_nt", + "in": "query", + "type": "string", + "description": "JUNCTION nucleotide sequence (Sequence of the CDR3 region + conserved residues (nucleotide)) (AIRR)\n" + }, + "junction_nt_form": { + "name": "junction_nt", + "in": "formData", + "type": "string", + "description": "JUNCTION nucleotide sequence (Sequence of the CDR3 region + conserved residues (nucleotide)) (AIRR)\n" + }, + "junction_aa": { + "name": "junction_aa", + "in": "query", + "type": "string", + "description": "JUNCTION amino acid sequence (Sequence of the CDR3 region + conserved residues (amino acid)) (AIRR)\n" + }, + "junction_aa_form": { + "name": "junction_aa", + "in": "formData", + "type": "string", + "description": "JUNCTION amino acid sequence (Sequence of the CDR3 region + conserved residues (amino acid)) (AIRR)\n" + }, + "duplicate_count": { + "name": "duplicate_count", + "in": "query", + "type": "integer", + "description": "Number of times the sequence has been duplicated in a file (AIRR)\n" + }, + "duplicate_count_form": { + "name": "duplicate_count", + "in": "formData", + "type": "integer", + "description": "Number of times the sequence has been duplicated in a file (AIRR)\n" + }, + "junction_length": { + "name": "junction_length", + "in": "query", + "type": "integer", + "description": "Number of junction nucleotides in sequence_vdj (CDR3 + conserved residues)\n" + }, + "junction_length_form": { + "name": "junction_length", + "in": "formData", + "type": "integer", + "description": "Number of junction nucleotides in sequence_vdj (CDR3 + conserved residues)\n" + }, + "junction_aa_length": { + "name": "junction_aa_length", + "in": "query", + "description": "Length of JUNCTION (CDR3 + conserved residues) in amino acids", + "required": false, + "type": "integer" + }, + "junction_aa_length_form": { + "name": "junction_aa_length", + "in": "formData", + "description": "Length of JUNCTION (CDR3 + conserved residues) in amino acids", + "required": false, + "type": "integer" + }, + "functional": { + "name": "functional", + "in": "query", + "type": "boolean", + "default": true, + "description": "Filter for sequences that are either functional, non-functional, or both\n" + }, + "functional_form": { + "name": "functional", + "in": "formData", + "type": "boolean", + "default": true, + "description": "Filter for sequences that are either functional, non-functional, or both\n" + }, + "ir_sample_id_list": { + "name": "ir_project_sample_id_list", + "in": "query", + "description": "List of unique identifiers (specific to the repository) that identify the samples to apply the query to.\n", + "required": false, + "type": "array", + "items": { + "type": "string" + } + }, + "ir_sample_id_list_form": { + "name": "ir_project_sample_id_list", + "in": "formData", + "description": "List of unique identifiers (specific to the repository) that identify the samples to apply the query to.\n", + "required": false, + "type": "array", + "items": { + "type": "string" + } + }, + "ir_data_format": { + "name": "ir_data_format", + "in": "query", + "description": "Data format to return the sequence data in, one of:
'csv' - vQuest based CSV (as per /v1)(default)
'tsv' - vQuest based TSV (as per /v1 with tab delimiters instead of commas);
'airr' - AIRR Formats rearrangements TSV (as per AIRR formats rearrangements spec)", + "required": false, + "type": "string" + }, + "ir_data_format_form": { + "name": "ir_data_format", + "in": "formData", + "description": "Data format to return the sequence data in, one of:
'csv' - vQuest based CSV (as per /v1)(default)
'tsv' - vQuest based TSV (as per /v1 with tab delimiters instead of commas);
'airr' - AIRR Formats rearrangements TSV (as per AIRR formats rearrangements spec)", + "required": false, + "type": "string" + }, + "ir_show_unproductive": { + "name": "ir_show_unproductive", + "in": "query", + "description": "By default, only productive sequences are returned. In order to return unproductive sequences, set this parameter to \"T\"\n", + "required": false, + "type": "array", + "items": { + "type": "boolean" + } + }, + "ir_show_unproductive_form": { + "name": "ir_show_unproductive", + "in": "formData", + "description": "By default, only productive sequences are returned. In order to return unproductive sequences, set this parameter to \"T\"\n", + "required": false, + "type": "array", + "items": { + "type": "boolean" + } + }, + "ir_junction_nt_length": { + "name": "ir_junction_nt_length", + "in": "query", + "description": "Length of JUNCTION (CDR3 + conserved residues) in nucleotide base pairs (iReceptor)", + "required": false, + "type": "integer" + }, + "ir_junction_nt_length_form": { + "name": "ir_junction_nt_length", + "in": "formData", + "description": "Length of JUNCTION (CDR3 + conserved residues) in nucleotide base pairs (iReceptor)", + "required": false, + "type": "integer" + } + }, "schemes": [ - "http", "https" ], "produces": [ "application/json" ], + "consumes": [ + "application/x-www-form-urlencoded" + ], "tags": [ + { + "name": "info", + "description": "Service information" + }, { "name": "samples", "description": "Queries for samples" @@ -34,7 +691,57 @@ } ], "paths": { + "/": { + "x-swagger-router-controller": "status", + "get": { + "description": "Service heartbeat.\n", + "operationId": "getStatus", + "responses": { + "200": { + "description": "Success.\n", + "schema": { + "type": "object", + "properties": { + "result": { + "type": "string" + } + } + } + } + } + } + }, + "/info": { + "x-swagger-router-controller": "status", + "get": { + "description": "Service information.\n", + "tags": [ + "info" + ], + "operationId": "getInfo", + "responses": { + "200": { + "description": "Success.\n", + "schema": { + "type": "object", + "properties": { + "name": { + "type": "string" + }, + "version": { + "type": "string" + } + } + } + } + } + } + }, + "/swagger": { + "x-swagger-pipe": "swagger_raw" + }, "/samples": { + "x-swagger-router-controller": "samples", "get": { "description": "This service returns metadata about samples, including higher-level meta-data around the study, subject, diagnosis, and sample processing (data relevant to MiAIRR data classes 1 through 3). The data returned is filtered based on the parameters provided.\nA successful call returns a json list with a sample level summary of each sample including a summary count of the number of sequences found for that sample.\n", "tags": [ @@ -42,275 +749,72 @@ ], "parameters": [ { - "name": "username", - "in": "query", - "description": "Username of the individual requesting access to the iReceptor repository node.\n", - "required": true, - "type": "string" + "$ref": "#/parameters/ir_username" }, { - "name": "lab_id", - "in": "query", - "description": "e.g. 1\n", - "required": false, - "type": "integer" + "$ref": "#/parameters/ir_project_id" }, { - "name": "project_id", - "in": "query", - "description": "e.g. 1\n", - "required": false, - "type": "array", - "items": { - "type": "integer" - } + "$ref": "#/parameters/study_id" }, { - "name": "subject_code", - "in": "query", - "description": "e.g. test\n", - "required": false, - "type": "string" + "$ref": "#/parameters/study_title" }, { - "name": "subject_gender", - "in": "query", - "description": "e.g. Male or Female\n", - "required": false, - "type": "string" + "$ref": "#/parameters/study_description" }, { - "name": "subject_species", - "in": "query", - "description": "e.g. Human\n", - "required": false, - "type": "string" + "$ref": "#/parameters/lab_name" }, { - "name": "subject_ethnicity", - "in": "query", - "description": "e.g. Caucasian\n", - "required": false, - "type": "string" + "$ref": "#/parameters/subject_id" }, { - "name": "subject_age_min", - "in": "query", - "description": "e.g. 10\n", - "required": false, - "type": "integer" + "$ref": "#/parameters/organism" }, { - "name": "subject_age_max", - "in": "query", - "description": "e.g. 12\n", - "required": false, - "type": "integer" + "$ref": "#/parameters/sex" }, { - "name": "case_control_name", - "in": "query", - "description": "e.g. Control\n", - "required": false, - "type": "string" + "$ref": "#/parameters/ethnicity" }, { - "name": "sample_name", - "in": "query", - "description": "e.g. test2\n", - "required": false, - "type": "string" + "$ref": "#/parameters/study_group_description" }, { - "name": "sample_source_name", - "in": "query", - "description": "e.g. Blood (PBMC)\n", - "required": false, - "type": "string" + "$ref": "#/parameters/sample_id" }, { - "name": "ireceptor_cell_subset_name", - "in": "query", - "description": "e.g. NaiveB\n", - "required": false, - "type": "string" + "$ref": "#/parameters/tissue" }, { - "name": "dna_type", - "in": "query", - "description": "e.g. cDNA, gDNA\n", - "required": false, - "type": "string" + "$ref": "#/parameters/disease_state_sample" + }, + { + "$ref": "#/parameters/cell_subset" + }, + { + "$ref": "#/parameters/cell_phenotype" + }, + { + "$ref": "#/parameters/template_class" + }, + { + "$ref": "#/parameters/sequencing_platform" + }, + { + "$ref": "#/parameters/ir_subject_age_min" + }, + { + "$ref": "#/parameters/ir_subject_age_max" } ], "operationId": "getSamples", "responses": { "200": { - "description": "A successful call returns the metadata for each sample, including\nthe number of sequences found for that sample.\n", + "description": "A successful call returns an array of sample summary metadata for\neach sample that meets the search criteria. The metadata returned\nfor each sample includes the number of sequences found for that sample\nas well as the study/subject/sample data for that sample. The metadata\nfor each sample in the response contains a set of AIRR compliant data\nas well as repository specific data that is required to query the\nrepository about those types of elements. \n", "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "sequence_count": { - "type": "integer", - "description": "e.g. 0\n" - }, - "subject_code": { - "type": "string", - "description": "e.g. Subject One\n" - }, - "subject_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "subject_gender": { - "type": "string", - "description": "e.g. Male\n" - }, - "subject_ethnicity": { - "type": "string", - "description": "e.g. Eth1\n" - }, - "subject_age": { - "type": "integer", - "description": "e.g. 1\n" - }, - "project_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "study_title": { - "type": "string", - "description": "Publication or Protocol Title (e.g. My Study) (AIRR)(v1 = project_name)\n" - }, - "study_type": { - "type": "string", - "description": "Type of project/study (e.g. Cancer) (AIRR)(v1 = project_type)\n" - }, - "project_parent_id": { - "type": "integer", - "description": "e.g. null\n" - }, - "lab_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "lab_name": { - "type": "string", - "description": "Name of the Laboratory running the study (AIRR)\n" - }, - "case_control_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "case_control_name": { - "type": "string", - "description": "e.g. Control\n" - }, - "sample_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "sample_name": { - "type": "string", - "description": "e.g. Blood Sample 01\n" - }, - "project_sample_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "sample_subject_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "dna_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "dna_type": { - "type": "string", - "description": "e.g. cDNA\n" - }, - "sample_source_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "sample_source_name": { - "type": "string", - "description": "e.g. Blood (PBMC)\n" - }, - "lab_cell_subset_name": { - "type": "string", - "description": "e.g. Naive B Alpha\n" - }, - "ireceptor_cell_subset_name": { - "type": "string", - "description": "e.g. Naive B\n" - }, - "marker_1": { - "type": "string", - "description": "e.g. CR19\n" - }, - "marker_2": { - "type": "string", - "description": "e.g. CR20\n" - }, - "marker_3": { - "type": "string", - "description": "e.g. CR21\n" - }, - "marker_4": { - "type": "string", - "description": "e.g. null\n" - }, - "marker_5": { - "type": "string", - "description": "e.g. null\n" - }, - "marker_6": { - "type": "string", - "description": "e.g. null\n" - } - } - } - }, - "examples": { - "application/json": [ - { - "sequence_count": 1234567, - "subject_code": "Subject One", - "subject_id": 1, - "subject_gender": "Male", - "subject_ethnicity": "Caucasian", - "subject_species": "Human", - "project_id": 0, - "study_title": "First Project", - "study_type": "Cancer", - "project_parent_id": null, - "lab_id": 0, - "lab_name": "First Lab", - "case_control_id": 0, - "case_control_name": "Control", - "sample_id": 1, - "project_sample_id": 1, - "sample_name": "Blood Sample 01", - "subject_age": 22, - "sample_subject_id": 1, - "dna_id": 1, - "dna_type": "cDNA", - "sample_source_id": 2, - "sample_source_name": "Blood (PBMC)", - "lab_cell_subset_name": "Naive B Alpha", - "ireceptor_cell_subset_name": "Naive B", - "marker_1": "CR19", - "marker_2": "CR20", - "marker_3": "CR21", - "marker_4": null, - "marker_5": null, - "marker_6": null - } - ] + "$ref": "#/definitions/ireceptor_sample_summary_response" } }, "400": { @@ -337,259 +841,72 @@ ], "parameters": [ { - "name": "query", - "in": "body", - "required": true, - "schema": { - "type": "object", - "required": [ - "username" - ], - "properties": { - "username": { - "type": "string", - "description": "Username of the individual requesting access to the iReceptor repository node.\n" - }, - "lab_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "project_id": { - "type": "array", - "items": { - "type": "integer" - }, - "description": "e.g. 1\n" - }, - "subject_code": { - "type": "string", - "description": "e.g. test\n" - }, - "subject_gender": { - "type": "string", - "description": "e.g. Male\n" - }, - "subject_ethnicity": { - "type": "string", - "description": "e.g. Caucasian\n" - }, - "subject_species": { - "type": "string", - "description": "e.g. Human\n" - }, - "subject_age_min": { - "type": "integer", - "description": "e.g. 10\n" - }, - "subject_age_max": { - "type": "integer", - "description": "e.g. 12\n" - }, - "case_control_name": { - "type": "string", - "description": "e.g. Control\n" - }, - "sample_name": { - "type": "string", - "description": "e.g. test2\n" - }, - "sample_source_name": { - "type": "array", - "items": { - "type": "string" - }, - "description": "e.g. Blood (PBMC)\n" - }, - "ireceptor_cell_subset_name": { - "type": "array", - "items": { - "type": "string" - }, - "description": "e.g. NaiveB\n" - }, - "dna_type": { - "type": "array", - "items": { - "type": "string" - }, - "description": "e.g. cDNA\n" - } - } - } + "$ref": "#/parameters/ir_username_form" + }, + { + "$ref": "#/parameters/ir_project_id_form" + }, + { + "$ref": "#/parameters/study_id_form" + }, + { + "$ref": "#/parameters/study_title_form" + }, + { + "$ref": "#/parameters/study_description_form" + }, + { + "$ref": "#/parameters/lab_name_form" + }, + { + "$ref": "#/parameters/subject_id_form" + }, + { + "$ref": "#/parameters/organism_form" + }, + { + "$ref": "#/parameters/sex_form" + }, + { + "$ref": "#/parameters/ethnicity_form" + }, + { + "$ref": "#/parameters/study_group_description_form" + }, + { + "$ref": "#/parameters/sample_id_form" + }, + { + "$ref": "#/parameters/tissue_form" + }, + { + "$ref": "#/parameters/disease_state_sample_form" + }, + { + "$ref": "#/parameters/cell_subset_form" + }, + { + "$ref": "#/parameters/cell_phenotype_form" + }, + { + "$ref": "#/parameters/template_class_form" + }, + { + "$ref": "#/parameters/sequencing_platform_form" + }, + { + "$ref": "#/parameters/ir_subject_age_min_form" + }, + { + "$ref": "#/parameters/ir_subject_age_max_form" } ], "operationId": "postSamples", "responses": { "200": { - "description": "A successful call returns the metadata for each sample, including\nthe number of sequences found for that sample.\n", + "description": "A successful call returns an array of sample summary metadata for each sample that meets the search criteria. The metadata returned for each sample includes the number of sequences found for that sample as well as the study/subject/sample data for that sample. The metadata for each sample in the response contains a set of AIRR compliant data as well as repository specific data that is required to query the repository about those types of elements. \n", "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "subject_code": { - "type": "string", - "description": "e.g. Subject One\n" - }, - "subject_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "subject_gender": { - "type": "string", - "description": "e.g. Male\n" - }, - "subject_ethnicity": { - "type": "string", - "description": "e.g. Caucasian\n" - }, - "subject_species": { - "type": "string", - "description": "e.g. Human\n" - }, - "subject_age": { - "type": "integer", - "description": "e.g. 1\n" - }, - "project_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "study_title": { - "type": "string", - "description": "Publication or Protocol Title (e.g. My Study) (AIRR)(v1 = project_name)\n" - }, - "study_type": { - "type": "string", - "description": "Type of project/study (e.g. Cancer) (AIRR)(v1 = project_type)\n" - }, - "project_parent_id": { - "type": "integer", - "description": "e.g. null\n" - }, - "lab_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "lab_name": { - "type": "string", - "description": "Name of the Laboratory running the study (AIRR)\n" - }, - "case_control_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "case_control_name": { - "type": "string", - "description": "e.g. Control\n" - }, - "sample_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "sample_name": { - "type": "string", - "description": "e.g. Blood Sample 01\n" - }, - "project_sample_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "sample_subject_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "sequence_count": { - "type": "integer", - "description": "e.g. 0\n" - }, - "dna_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "dna_type": { - "type": "string", - "description": "e.g. cDNA\n" - }, - "sample_source_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "sample_source_name": { - "type": "string", - "description": "e.g. Blood (PBMC)\n" - }, - "lab_cell_subset_name": { - "type": "string", - "description": "e.g. Naive B Alpha\n" - }, - "ireceptor_cell_subset_name": { - "type": "string", - "description": "e.g. Naive B\n" - }, - "marker_1": { - "type": "string", - "description": "e.g. CR19\n" - }, - "marker_2": { - "type": "string", - "description": "e.g. CR20\n" - }, - "marker_3": { - "type": "string", - "description": "e.g. CR21\n" - }, - "marker_4": { - "type": "string", - "description": "e.g. null\n" - }, - "marker_5": { - "type": "string", - "description": "e.g. null\n" - }, - "marker_6": { - "type": "string", - "description": "e.g. null\n" - } - } - } - }, - "examples": { - "application/json": [ - { - "sequence_count": 1234567, - "subject_code": "Subject One", - "subject_id": 1, - "subject_gender": "Male", - "subject_ethnicity": "Caucasian", - "subject_species": "Human", - "project_id": 0, - "study_title": "First Project", - "study_type": "Cancer", - "project_parent_id": null, - "lab_id": 0, - "lab_name": "First Lab", - "case_control_id": 0, - "case_control_name": "Control", - "sample_id": 1, - "project_sample_id": 1, - "sample_name": "Blood Sample 01", - "subject_age": 22, - "sample_subject_id": 1, - "dna_id": 1, - "dna_type": "cDNA", - "sample_source_id": 2, - "sample_source_name": "Blood (PBMC)", - "lab_cell_subset_name": "Naive B Alpha", - "ireceptor_cell_subset_name": "Naive B", - "marker_1": "CR19", - "marker_2": "CR20", - "marker_3": "CR21", - "marker_4": null, - "marker_5": null, - "marker_6": null - } - ] + "$ref": "#/definitions/ireceptor_sample_summary_response" } }, "400": { @@ -611,848 +928,127 @@ } }, "/sequences_summary": { + "x-swagger-router-controller": "sequences", "get": { - "description": "This service returns a summary of sequences that matches the GET provided filter. \"username\" parameter refers to external_users table.\n", + "description": "This service returns a summary of sequences that matches the GET provided filter. \"ir_username\" parameter refers to user requesting access to the repository.\n", "tags": [ "sequences" ], "parameters": [ { - "name": "username", - "in": "query", - "description": "Username of the individual requesting access to the iReceptor repository node.\n", - "required": true, - "type": "string" + "$ref": "#/parameters/ir_username" }, { - "name": "project_sample_id_list", - "in": "query", - "required": true, - "type": "array", - "items": { - "type": "integer" - } + "$ref": "#/parameters/ir_sample_id_list" }, { - "name": "cdr3_length", - "in": "query", - "description": "length of complementarity determining region in nucleotide base pairs", - "required": false, - "type": "integer" + "$ref": "#/parameters/v_call" }, { - "name": "vgene_string", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/d_call" }, { - "name": "jgene_string", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/j_call" + }, + { + "$ref": "#/parameters/junction_aa" + }, + { + "$ref": "#/parameters/junction_length" + }, + { + "$ref": "#/parameters/junction_aa_length" + }, + { + "$ref": "#/parameters/functional" + }, + { + "$ref": "#/parameters/ir_show_unproductive" } ], "operationId": "getSequenceSummary", "responses": { "200": { - "description": "A successful call returns an summary of sequence data as an array of 'category' = count pairs in which the 'category' are string tags of parameters of interest from a controlled vocabulary term set.\n", + "description": "A successful call returns two components, an aggregated summary of the data that satisfies the query and an example subset of the annotated sequence data that meets the query criteria. The aggreated data returns a summary similar to that returned by the /samples API entry point, returning the number of sequences and the study/subject/sample meta-data for each sample. The example subset of sequence data that is returned is a small subset of annotated sequences that met the search criteria. The number of sequences returned is given in the \"num_sequences\" paramter to the query and the format in which the sequences are returned is provided by the \"sequence_format\" parameter to the query.\n", "schema": { "type": "object", "properties": { - "aggregation_summary": { - "type": "array", - "items": { - "type": "object", - "properties": { - "subject_code": { - "type": "string", - "description": "e.g. Subject One\n" - }, - "subject_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "subject_gender": { - "type": "string", - "description": "e.g. Male\n" - }, - "subject_species": { - "type": "string", - "description": "e.g. Mouse\n" - }, - "subject_ethnicity": { - "type": "string", - "description": "e.g. Eth1\n" - }, - "subject_age": { - "type": "integer", - "description": "e.g. 1\n" - }, - "project_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "study_title": { - "type": "string", - "description": "Publication or Protocol Title (e.g. My Study) (AIRR)(v1 = project_name)\n" - }, - "study_type": { - "type": "string", - "description": "Type of project/study (e.g. Cancer) (AIRR)(v1 = project_type)\n" - }, - "project_parent_id": { - "type": "integer", - "description": "e.g. null\n" - }, - "study": { - "type": "string", - "description": "Alphanumeric UID assigned by NCBI (e.g. PRJNA349) (AIRR)(sra_accession)\n" - }, - "lab_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "lab_name": { - "type": "string", - "description": "Name of the Laboratory running the study (AIRR)\n" - }, - "disease_state_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "disease_state_name": { - "type": "string", - "description": "e.g. HIV-1 infected\n" - }, - "case_control_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "case_control_name": { - "type": "string", - "description": "e.g. Control\n" - }, - "sample_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "sample_name": { - "type": "string", - "description": "e.g. Blood Sample 01\n" - }, - "project_sample_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "sample_subject_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "sequence_count": { - "type": "integer", - "description": "e.g. 0\n" - }, - "dna_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "dna_type": { - "type": "string", - "description": "e.g. cDNA\n" - }, - "sample_source_id": { - "type": "integer", - "description": "e.g. 0\n" - }, - "sample_source_name": { - "type": "string", - "description": "e.g. Blood (PBMC)\n" - }, - "lab_cell_subset_name": { - "type": "string", - "description": "e.g. Naive B Alpha\n" - }, - "ireceptor_cell_subset_name": { - "type": "string", - "description": "e.g. Naive B\n" - }, - "marker_1": { - "type": "string", - "description": "e.g. CR19\n" - }, - "marker_2": { - "type": "string", - "description": "e.g. CR20\n" - }, - "marker_3": { - "type": "string", - "description": "e.g. CR21\n" - }, - "marker_4": { - "type": "string", - "description": "e.g. null\n" - }, - "marker_5": { - "type": "string", - "description": "e.g. null\n" - }, - "marker_6": { - "type": "string", - "description": "e.g. null\n" - }, - "sequences": { - "type": "integer", - "description": "e.g. 167793\n" - } - } - } + "summary": { + "$ref": "#/definitions/ireceptor_sequence_summary_response" }, - "sequences": { - "type": "array", - "items": { - "type": "object", - "properties": { - "seq_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "seq_name": { - "type": "string" - }, - "project_sample_id": { - "type": "integer", - "description": "e.g. 6\n" - }, - "id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "sequence_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "vgene_string": { - "type": "string", - "description": "e.g IGHV4-59*01 or IGHV4-59*07\n" - }, - "vgene_family": { - "type": "string", - "description": "e.g. IGHV4\n" - }, - "vgene_gene": { - "type": "string", - "description": "e.g. IGHV4-59\n" - }, - "vgene_allele": { - "type": "string", - "description": "e.g. IGHV4-59*01 or IGHV4-59*07\n" - }, - "dgene_string": { - "type": "string", - "description": "e.g. Homsap IGHD3-10*01 F\n" - }, - "dgene_family": { - "type": "string", - "description": "e.g. IGHD3\n" - }, - "dgene_gene": { - "type": "string", - "description": "e.g. IGHD3-10\n" - }, - "dgene_allele": { - "type": "string", - "description": "e.g. IGHD3-10*01\n" - }, - "jgene_string": { - "type": "string", - "description": "e.g. Homsap IGHJ4*02 F\n" - }, - "jgene_family": { - "type": "string", - "description": "e.g. IGHJ4\n" - }, - "jgene_gene": { - "type": "string", - "description": "e.g. IGHJ4\n" - }, - "jgene_allele": { - "type": "string", - "description": "e.g. IGHJ4*02\n" - }, - "functionality": { - "type": "string", - "description": "e.g. productive\n" - }, - "functionality_comment": { - "type": "string", - "description": "e.g. \"\"\n" - }, - "orientation": { - "type": "string", - "description": "e.g. +\n" - }, - "vgene_score": { - "type": "integer", - "description": "e.g. 1127\n" - }, - "vgene_probability": { - "type": "integer", - "description": "e.g. 95\n" - }, - "dregion_reading_frame": { - "type": "integer", - "description": "e.g. 2\n" - }, - "cdr1_length": { - "type": "integer", - "description": "e.g. 8\n" - }, - "cdr2_length": { - "type": "integer", - "description": "e.g. 7\n" - }, - "cdr3_length": { - "type": "integer", - "description": "e.g. 13\n" - }, - "vdjregion_sequence_nt": { - "type": "string", - "description": "vdj region nucleotide sequence\n" - }, - "vjregion_sequence_nt": { - "type": "string", - "description": "vj region nucleotide sequence\n" - }, - "djregion_sequence_nt": { - "type": "string", - "description": "dj region nucleotide sequence\n" - }, - "vregion_sequence_nt": { - "type": "string", - "description": "v region nucleotide sequence\n" - }, - "dregion_sequence_nt": { - "type": "string", - "description": "d region nucleotide sequence\n" - }, - "jregion_sequence_nt": { - "type": "string", - "description": "j region nucleotide sequence\n" - }, - "fr1region_sequence_nt": { - "type": "string", - "description": "fr1 region nucleotide sequence\n" - }, - "fr2region_sequence_nt": { - "type": "string", - "description": "fr2 region nucleotide sequence\n" - }, - "fr3region_sequence_nt": { - "type": "string", - "description": "fr3 region nucleotide sequence\n" - }, - "fr4region_sequence_nt": { - "type": "string", - "description": "fr4 region nucleotide sequence\n" - }, - "cdr1region_sequence_nt": { - "type": "string", - "description": "cdr1 region nucleotide sequence\n" - }, - "cdr2region_sequence_nt": { - "type": "string", - "description": "cdr2 region nucleotide sequence\n" - }, - "cdr3region_sequence_nt": { - "type": "string", - "description": "cdr3 region nucleotide sequence\n" - }, - "junction_sequence_nt": { - "type": "string", - "description": "junction nucleotide sequence\n" - }, - "vdjregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped vdj region nucleotide sequence\n" - }, - "vjregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped vj region nucleotide sequence\n" - }, - "djregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped dj region nucleotide sequence\n" - }, - "vregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped v region nucleotide sequence\n" - }, - "dregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped d region nucleotide sequence\n" - }, - "jregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped j region nucleotide sequence\n" - }, - "fr1region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr1 region nucleotide sequence\n" - }, - "fr2region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr2 region nucleotide sequence\n" - }, - "fr3region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr3 region nucleotide sequence\n" - }, - "fr4region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr4 region nucleotide sequence\n" - }, - "cdr1region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr1 region nucleotide sequence\n" - }, - "cdr2region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr2 region nucleotide sequence\n" - }, - "cdr3region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr3 region nucleotide sequence\n" - }, - "junction_sequence_nt_gapped": { - "type": "string", - "description": "gapped junction nucleotide sequence\n" - }, - "vdjregion_sequence_aa": { - "type": "string", - "description": "vdj region amino acid sequence\n" - }, - "vjregion_sequence_aa": { - "type": "string", - "description": "vj region amino acid sequence\n" - }, - "djregion_sequence_aa": { - "type": "string", - "description": "dj region amino acid sequence\n" - }, - "vregion_sequence_aa": { - "type": "string", - "description": "v region amino acid sequence\n" - }, - "dregion_sequence_aa": { - "type": "string", - "description": "d region amino acid sequence\n" - }, - "jregion_sequence_aa": { - "type": "string", - "description": "j region amino acid sequence\n" - }, - "fr1region_sequence_aa": { - "type": "string", - "description": "fr1 region amino acid sequence\n" - }, - "fr2region_sequence_aa": { - "type": "string", - "description": "fr2 region amino acid sequence\n" - }, - "fr3region_sequence_aa": { - "type": "string", - "description": "fr3 region amino acid sequence\n" - }, - "fr4region_sequence_aa": { - "type": "string", - "description": "fr4 region amino acid sequence\n" - }, - "cdr1region_sequence_aa": { - "type": "string", - "description": "cdr1 region amino acid sequence\n" - }, - "cdr2region_sequence_aa": { - "type": "string", - "description": "cdr2 region amino acid sequence\n" - }, - "cdr3region_sequence_aa": { - "type": "string", - "description": "cdr3 region amino acid sequence\n" - }, - "junction_sequence_aa": { - "type": "string", - "description": "junction amino acid sequence\n" - }, - "vdjregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped vdj region amino acid sequence\n" - }, - "vjregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped vj region amino acid sequence\n" - }, - "djregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped dj region amino acid sequence\n" - }, - "vregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped v region amino acid sequence\n" - }, - "dregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped d region amino acid sequence\n" - }, - "jregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped j region amino acid sequence\n" - }, - "fr1region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr1 region amino acid sequence\n" - }, - "fr2region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr2 region amino acid sequence\n" - }, - "fr3region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr3 region amino acid sequence\n" - }, - "fr4region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr4 region amino acid sequence\n" - }, - "cdr1region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr1 region amino acid sequence\n" - }, - "cdr2region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr2 region amino acid sequence\n" - }, - "cdr3region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr3 region amino acid sequence\n" - }, - "junction_sequence_aa_gapped": { - "type": "string", - "description": "gapped junction amino acid sequence\n" - }, - "vdjregion_start": { - "type": "integer", - "description": "e.g. 1\n" - }, - "vdjregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "vjregion_start": { - "type": "integer", - "description": "e.g. 0\n" - }, - "vjregion_end": { - "type": "integer", - "description": "e.g. 0\n" - }, - "djregion_start": { - "type": "integer", - "description": "e.g. 254\n" - }, - "djregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "vregion_start": { - "type": "integer", - "description": "e.g. 286\n" - }, - "vregion_end": { - "type": "integer", - "description": "e.g. 252\n" - }, - "dregion_start": { - "type": "integer", - "description": "e.g. 254\n" - }, - "dregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "jregion_start": { - "type": "integer", - "description": "e.g. 286\n" - }, - "jregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "fr1region_start": { - "type": "integer", - "description": "e.g. 1\n" - }, - "fr1region_end": { - "type": "integer", - "description": "e.g. 38\n" - }, - "fr2region_start": { - "type": "integer", - "description": "e.g. 63\n" - }, - "fr2region_end": { - "type": "integer", - "description": "e.g. 113\n" - }, - "fr3region_start": { - "type": "integer", - "description": "e.g. 135\n" - }, - "fr3region_end": { - "type": "integer", - "description": "e.g. 248\n" - }, - "fr4region_start": { - "type": "integer", - "description": "e.g. 288\n" - }, - "fr4region_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "cdr1region_start": { - "type": "integer", - "description": "e.g. 39\n" - }, - "cdr1region_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "cdr2region_start": { - "type": "integer", - "description": "e.g. 62\n" - }, - "cdr2region_end": { - "type": "integer", - "description": "e.g. 134\n" - }, - "cdr3region_start": { - "type": "integer", - "description": "e.g. 249\n" - }, - "cdr3region_end": { - "type": "integer", - "description": "e.g. 287\n" - }, - "junction_start": { - "type": "integer", - "description": "e.g. 246\n" - }, - "junction_end": { - "type": "integer", - "description": "e.g. 290\n" - }, - "vregion_mutation_string": { - "type": "string", - "description": "e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c|\n" - }, - "fr1region_mutation_string": { - "type": "string", - "description": "e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)|\n" - }, - "fr2region_mutation_string": { - "type": "string", - "description": "e.g. \n" - }, - "fr3region_mutation_string": { - "type": "string", - "description": "e.g. c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c|\"\n" - }, - "cdr1region_mutation_string": { - "type": "string", - "description": "e.g.\n" - }, - "cdr2region_mutation_string": { - "type": "string", - "description": "e.g. a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|\"\n" - }, - "cdr3region_mutation_string": { - "type": "string", - "description": "e.g. g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t\n" - }, - "annotation_tool": { - "type": "string", - "description": "e.g. VQuest\n" - } - } - } + "items": { + "$ref": "#/definitions/ireceptor_sequence_response" } } - }, - "examples": { - "application/json": { - "aggregation_summary": [ - { - "subject_code": "IAVI 84", - "subject_id": 1, - "subject_gender": null, - "subject_ethnicity": "NA", - "subject_species": "Homo Sapiens", - "project_id": 1, - "study_title": "Mining the antibodyome for HIV-1 neutralizing antibodies with next generation sequencing and phylogenetic pairing of heavy/light chains", - "study_type": "HIV", - "project_parent_id": -1, - "study": "SRP018335", - "lab_id": 1, - "lab_name": "National Institute of Allergy and Infectious -DiseaseVaccine", - "Research Center": "Kwong Lab", - "disease_state_id": 7, - "disease_state_name": "HIV-1 infected for at least 3 years, not receiving antiretroviral treatment", - "case_control_id": 1, - "case_control_name": "Case", - "sample_id": 1, - "project_sample_id": 1, - "sequence_count": 253684, - "project_sample_note": null, - "sra_run_id": "SRR654169", - "sample_name": "SRS388604", - "subject_age": null, - "sample_subject_id": 1, - "dna_id": 1, - "dna_type": "cDNA", - "sample_source_id": 1, - "sample_source_name": "PBMCs", - "lab_cell_subset_name": "B cell memory", - "ireceptor_cell_subset_name": "Memory B Cell", - "marker_1": "IgG+", - "marker_2": "CD19+", - "marker_3": "sIgG+", - "marker_4": " negative depletion to CD3", - "marker_5": " CD14", - "marker_6": " CD16, IgM, IgA, IgD ", - "sequences": 167793 - } - ], - "sequences": [ - { - "seq_id": 2, - "seq_name": "SRR654169.17_G912ZWU01EPN4E_length=379", - "project_sample_id": 1, - "id": 37, - "vgene_string": "Homsap IGHV1-24*01 F", - "vgene_family": "IGHV1", - "vgene_gene": "IGHV1-24", - "vgene_allele": " IGHV1-24*01 ", - "jgene_string": "Homsap IGHJ3*02 F", - "jgene_family": "IGHJ3", - "jgene_gene": "IGHJ3", - "jgene_allele": " IGHJ3*02 ", - "dgene_string": "Homsap IGHD3-22*01 F", - "dgene_family": "IGHD3", - "dgene_gene": "IGHD3-22", - "dgene_allele": " IGHD3-22*01 ", - "functionality": "productive", - "vgene_score": 1417, - "vgene_probablity": null, - "dregion_reading_frame": "3", - "cdr1_length": 8, - "cdr2_length": 8, - "cdr3_length": 17, - "vdjregion_sequence_nt": "caggtccagctggtagagtctggggctgaggtgaagaagcctggggcctcagtgaaggtctcctgcaagtttccggatacaccctcactgaattatccatgcactgggtgcgacaggctcctggaaaagggcttgatggatgggaggttttgatcctgaagatggtgaaacaatctacgcacagaagttccagggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgtgcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatctggggccaagggacaatggtcaccgtctcttcag", - "vjregion_sequence_nt": "", - "djregion_sequence_nt": "gatagttgtgattatggacgatggttttgatatctggggccaagggacaatggtcaccgtctcttcag", - "vregion_sequence_nt": "caggtccagctggtagagtctggggctgaggtgaagaagcctggggcctcagtgaaggtctcctgcaaggtttccggatacaccctcactgaattatccatgcactgggtgcgacaggctcctggaaaagggcttgagtggatgggaggttttgatcctgaagatggtgaaacaatctacgcacagaagttccagggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgtgcaaca", - "jregion_sequence_nt": "gatggttttgatatctggggccaagggacaatggtcaccgtctcttcag", - "dregion_sequence_nt": "gatagttgtgattat", - "fr1region_sequence_nt": "caggtccagctggtagagtctggggctgaggtgaagaagcctggggcctcagtgaaggtctcctgcaaggtttcc", - "fr2region_sequence_nt": "atgcactgggtgcgacaggctcctggaaaagggcttgagtggatgggaggt", - "fr3region_sequence_nt": "atctacgcacagaagttccagggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgt", - "fr4region_sequence_nt": "tggggccaagggacaatggtcaccgtctcttcag", - "cdr1region_sequence_nt": "ggatacaccctcactgaattatcc", - "cdr2region_sequence_nt": "tttgatcctgaagatggtgaaaca", - "cdr3region_sequence_nt": "gcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatc", - "junction_sequence_nt": "tgtgcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatctgg", - "vdjregion_sequence_nt_gapped": "caggtccagctggtagagtctggggct...gaggtgaagaagcctggggcctcagtgaaggtctcctgcaaggtttccggatacaccctc............actgaattatccatgcactgggtgcgacaggctcctggaaaagggcttgagtggatgggaggttttgatcctgaa......gatggtgaaacaatctacgcacagaagttccag...ggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgtgcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatctggggccaagggacaatggtcaccgtctcttcag", - "vjregion_sequence_nt_gapped": "", - "djregion_sequence_nt_gapped": null, - "vregion_sequence_nt_gapped": "caggtccagctggtagagtctggggct...gaggtgaagaagcctggggcctcagtgaaggtctcctgcaaggtttccggatacaccctc............actgaattatccatgcactgggtgcgacaggctcctggaaaagggcttgagtggatgggaggttttgatcctgaa......gatggtgaaacaatctacgcacagaagttccag...ggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgtgcaaca", - "jregion_sequence_nt_gapped": "gatggttttgatatctggggccaagggacaatggtcaccgtctcttcag", - "dregion_sequence_nt_gapped": "gatggttttgatatctggggccaagggacaatggtcaccgtctcttcag", - "fr1region_sequence_nt_gapped": "caggtccagctggtagagtctggggct ...gaggtgaagaagcctggggcctcagtgaaggtctcctgcaaggtttcc", - "fr2region_sequence_nt_gapped": "atgcactgggtgcgacaggctcctggaaaagggcttgagtggatgggaggt", - "fr3region_sequence_nt_gapped": "atctacgcacagaagttccag...ggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgt", - "fr4region_sequence_nt_gapped": "tggggccaagggacaatggtcaccgtctcttcag", - "cdr1region_sequence_nt_gapped": "ggatacaccctc............actgaattatcc", - "cdr2region_sequence_nt_gapped": "tttgatcctgaa......gatggtgaaaca", - "cdr3region_sequence_nt_gapped": "gcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatc", - "junction_sequence_nt_gapped": "tgtgcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatctgg", - "vdjregion_sequence_aa": "QVQLVESGAEVKKPGASVKVSCKVSGYTLTELSMHWVRQAPGKGLEWMGGFDPEDGETIYAQKFQGR ITMTEDTSTDTAYMELSSLRSEDTAVYYCATRSPPIVVIMDDGFDIWGQGTMVTVSS", - "vjregion_sequence_aa": "", - "djregion_sequence_aa": null, - "vregion_sequence_aa": "QVQLVESGAEVKKPGASVKVSCKVSGYTLTELSMHWVRQAPGKGLEWMGGFDPEDGETIYAQKFQGRITMTEDTSTDTAYMELSSLRSEDTAVYYCAT", - "jregion_sequence_aa": "DGFDIWGQGTMVTVSS", - "dregion_sequence_aa": null, - "fr1region_sequence_aa": "QVQLVESGAEVKKPGASVKVSCKVS", - "fr2region_sequence_aa": "MHWVRQAPGKGLEWMGG", - "fr3region_sequence_aa": "IYAQKFQGRITMTEDTSTDTAYMELSSLRSEDTAVYYC", - "fr4region_sequence_aa": "WGQGTMVTVSS", - "cdr1region_sequence_aa": "GYTLTELS", - "cdr2region_sequence_aa": "FDPEDGET", - "cdr3region_sequence_aa": "ATRSPPIVVIMDDGFDI", - "junction_sequence_aa": "CATRSPPIVVIMDDGFDIW", - "vdjregion_sequence_aa_gapped": "QVQLVESGA.EVKKPGASVKVSCKVSGYTL....TELSMHWVRQAPGKGLEWMGGFDPE..DGETIYAQKFQ.GRITMTEDTSTDTAYMELSSLRSEDTAVYYCATRSPPIVVIMDDGFDIWGQGTMVTVSS", - "vjregion_sequence_aa_gapped": "", - "djregion_sequence_aa_gapped": null, - "vregion_sequence_aa_gapped": "QVQLVESGA.EVKKPGASVKVSCKVSGYTL....TELSMHWVRQAPGKGLEWMGGFDPE..DGETIYAQKFQ.GRITMTEDTSTDTAYMELSSLRSEDTAVYYCAT", - "jregion_sequence_aa_gapped": "DGFDIWGQGTMVTVSS", - "dregion_sequence_aa_gapped": null, - "fr1region_sequence_aa_gapped": "QVQLVESGA.EVKKPGASVKVSCKVS", - "fr2region_sequence_aa_gapped": "MHWVRQAPGKGLEWMGG", - "fr3region_sequence_aa_gapped": "IYAQKFQ.GRITMTEDTSTDTAYMELSSLRSEDTAVYYC", - "fr4region_sequence_aa_gapped": "WGQGTMVTVSS", - "cdr1region_sequence_aa_gapped": "GYTL....TELS", - "cdr2region_sequence_aa_gapped": "FDPE..DGET", - "cdr3region_sequence_aa_gapped": "ATRSPPIVVIMDDGFDI", - "junction_sequence_aa_gapped": "CATRSPPIVVIMDDGFDIW", - "vdjregion_start": 2, - "vdjregion_end": 374, - "vjregion_start": null, - "vjregion_end": null, - "vregion_start": 2, - "vregion_end": 295, - "jregion_start": 326, - "jregion_end": 374, - "dregion_start": 307, - "dregion_end": 374, - "fr1region_start": 2, - "fr1region_end": 76, - "fr2region_start": 101, - "fr2region_end": 151, - "fr3region_start": 176, - "fr3region_end": 289, - "fr4region_start": 341, - "fr4region_end": 374, - "cdr1region_start": 77, - "cdr1region_end": 100, - "cdr2region_start": 152, - "cdr2region_end": 175, - "cdr3region_start": 290, - "cdr3region_end": 340, - "junction_start": 287, - "junction_end": 343, - "vregion_mutation_string": "c16>g,Q6>E(++ -)|g226>a,V76>I(+ - +)|", - "fr1region_mutation_string": "c16>g,Q6>E(+ + -)|", - "fr2region_mutation_string": "", - "fr3region_mutation_string": "g226>a,V76>I(+ - +)|", - "cdr1region_mutation_string": "", - "cdr2region_mutation_string": "", - "cdr3region_mutation_string": "g319>a|a320>g|", - "vgene_probability": "99", - "djregion_start": 307, - "djregion_end": 374, - "annotation_tool": "VQuest" - } - ] + } + }, + "400": { + "description": "malformed request" + }, + "401": { + "description": "authentication error" + }, + "403": { + "description": "authorization error" + }, + "404": { + "description": "data not found" + }, + "405": { + "description": "method not allowed" + } + } + }, + "post": { + "description": "This service returns a summary of sequences that matches the POST provided filter. \"ir_username\" parameter refers to user requesting access to the repository.\n", + "tags": [ + "sequences" + ], + "parameters": [ + { + "$ref": "#/parameters/ir_username_form" + }, + { + "$ref": "#/parameters/ir_sample_id_list_form" + }, + { + "$ref": "#/parameters/v_call_form" + }, + { + "$ref": "#/parameters/d_call_form" + }, + { + "$ref": "#/parameters/j_call_form" + }, + { + "$ref": "#/parameters/junction_aa_form" + }, + { + "$ref": "#/parameters/junction_length_form" + }, + { + "$ref": "#/parameters/junction_aa_length_form" + }, + { + "$ref": "#/parameters/functional_form" + }, + { + "$ref": "#/parameters/ir_show_unproductive_form" + } + ], + "operationId": "postSequenceSummary", + "responses": { + "200": { + "description": "A successful call returns two components, an aggregated summary of the data that satisfies the query and an example subset of the annotated sequence data that meets the query criteria. The aggreated data returns a summary similar to that returned by the /samples API entry point, returning the number of sequences and the study/subject/sample meta-data for each sample. The example subset of sequence data that is returned is a small subset of annotated sequences that met the search criteria. The number of sequences returned is given in the \"num_sequences\" paramter to the query and the format in which the sequences are returned is provided by the \"sequence_format\" parameter to the query.\n", + "schema": { + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/ireceptor_sequence_summary_response" + }, + "items": { + "$ref": "#/definitions/ireceptor_sequence_response" + } } } }, @@ -1474,7 +1070,8 @@ } } }, - "/sequence_data": { + "/sequences_data": { + "x-swagger-router-controller": "sequences", "get": { "description": "This service returns the annotation data that matches the GET provided filter. \"username\" parameter refers to external_users table, and it requires the array of \"project_sample_id\", which limits which samples the sequences will be taken from. Other parameters are optional, and refer to the sequence_md_view view in iReceptor database.\n", "tags": [ @@ -1482,46 +1079,37 @@ ], "parameters": [ { - "name": "username", - "in": "query", - "description": "Username of the individual requesting access to the iReceptor repository node.\n", - "required": true, - "type": "string" + "$ref": "#/parameters/ir_username" }, { - "name": "project_sample_id_list", - "in": "query", - "required": true, - "type": "array", - "items": { - "type": "integer" - } + "$ref": "#/parameters/ir_sample_id_list" }, { - "name": "cdr3_length", - "in": "query", - "description": "length of complementarity determining region in nucleotide base pairs", - "required": false, - "type": "integer" + "$ref": "#/parameters/ir_data_format" }, { - "name": "vgene_string", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/v_call" }, { - "name": "jgene_string", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/d_call" }, { - "name": "format", - "in": "query", - "description": "'csv' - vQuest based CSV (as per /v1); 'tsv' - vQuest based TSV (as per /v1 with tab delimiters instead of commas); 'airr' - AIRR Formats rearrangements TSV (as per AIRR formats rearrangements spec)", - "required": false, - "type": "string" + "$ref": "#/parameters/j_call" + }, + { + "$ref": "#/parameters/junction_aa" + }, + { + "$ref": "#/parameters/junction_length" + }, + { + "$ref": "#/parameters/junction_aa_length" + }, + { + "$ref": "#/parameters/functional" + }, + { + "$ref": "#/parameters/ir_show_unproductive" } ], "operationId": "getSequenceData", @@ -1529,514 +1117,7 @@ "200": { "description": "A successful call returns an array of sequence data. Optional \"format\" parameter determines the output format. Default is a JSON response, limited to top 50 results. If \"format\" is set to \"csv\", it will return all the matching sequence annotations, in addition to sample information and annotation tool information, in a comma-separated format; \"tsv\" returns a tab-delimited outputs; \"airr\" returns AIRR minimal standards encoded tab-delimited outputs.\n", "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "seq_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "seq_name": { - "type": "string" - }, - "project_sample_id": { - "type": "integer", - "description": "e.g. 6\n" - }, - "id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "sequence_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "vgene_string": { - "type": "string" - }, - "vgene_family": { - "type": "string", - "description": "e.g. IGHV4\n" - }, - "vgene_gene": { - "type": "string", - "description": "e.g. IGHV4-59\n" - }, - "vgene_allele": { - "type": "string", - "description": "e.g. IGHV4-59*01 or IGHV4-59*07\n" - }, - "dgene_string": { - "type": "string", - "description": "e.g. Homsap IGHD3-10*01 F\n" - }, - "dgene_family": { - "type": "string", - "description": "e.g. IGHD3\n" - }, - "dgene_gene": { - "type": "string", - "description": "e.g. IGHD3-10\n" - }, - "dgene_allele": { - "type": "string", - "description": "e.g. IGHD3-10*01\n" - }, - "jgene_string": { - "type": "string", - "description": "e.g. Homsap IGHJ4*02 F\n" - }, - "jgene_family": { - "type": "string", - "description": "e.g. IGHJ4\n" - }, - "jgene_gene": { - "type": "string", - "description": "e.g. IGHJ4\n" - }, - "jgene_allele": { - "type": "string", - "description": "e.g. IGHJ4*02\n" - }, - "functionality": { - "type": "string", - "description": "e.g. productive\n" - }, - "functionality_comment": { - "type": "string", - "description": "e.g. \"\"\n" - }, - "orientation": { - "type": "string", - "description": "e.g. +\n" - }, - "vgene_score": { - "type": "integer", - "description": "e.g. 1127\n" - }, - "vgene_probability": { - "type": "integer", - "description": "e.g. 95\n" - }, - "dregion_reading_frame": { - "type": "integer", - "description": "e.g. 2\n" - }, - "cdr1_length": { - "type": "integer", - "description": "e.g. 8\n" - }, - "cdr2_length": { - "type": "integer", - "description": "e.g. 7\n" - }, - "cdr3_length": { - "type": "integer", - "description": "e.g. 13\n" - }, - "vdjregion_sequence_nt": { - "type": "string", - "description": "vdj region nucleotide sequence\n" - }, - "vjregion_sequence_nt": { - "type": "string", - "description": "vj region nucleotide sequence\n" - }, - "djregion_sequence_nt": { - "type": "string", - "description": "dj region nucleotide sequence\n" - }, - "vregion_sequence_nt": { - "type": "string", - "description": "v region nucleotide sequence\n" - }, - "dregion_sequence_nt": { - "type": "string", - "description": "d region nucleotide sequence\n" - }, - "jregion_sequence_nt": { - "type": "string", - "description": "j region nucleotide sequence\n" - }, - "fr1region_sequence_nt": { - "type": "string", - "description": "fr1 region nucleotide sequence\n" - }, - "fr2region_sequence_nt": { - "type": "string", - "description": "fr2 region nucleotide sequence\n" - }, - "fr3region_sequence_nt": { - "type": "string", - "description": "fr3 region nucleotide sequence\n" - }, - "fr4region_sequence_nt": { - "type": "string", - "description": "fr4 region nucleotide sequence\n" - }, - "cdr1region_sequence_nt": { - "type": "string", - "description": "cdr1 region nucleotide sequence\n" - }, - "cdr2region_sequence_nt": { - "type": "string", - "description": "cdr2 region nucleotide sequence\n" - }, - "cdr3region_sequence_nt": { - "type": "string", - "description": "cdr3 region nucleotide sequence\n" - }, - "junction_sequence_nt": { - "type": "string", - "description": "junction nucleotide sequence\n" - }, - "vdjregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped vdj region nucleotide sequence\n" - }, - "vjregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped vj region nucleotide sequence\n" - }, - "djregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped dj region nucleotide sequence\n" - }, - "vregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped v region nucleotide sequence\n" - }, - "dregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped d region nucleotide sequence\n" - }, - "jregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped j region nucleotide sequence\n" - }, - "fr1region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr1 region nucleotide sequence\n" - }, - "fr2region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr2 region nucleotide sequence\n" - }, - "fr3region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr3 region nucleotide sequence\n" - }, - "fr4region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr4 region nucleotide sequence\n" - }, - "cdr1region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr1 region nucleotide sequence\n" - }, - "cdr2region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr2 region nucleotide sequence\n" - }, - "cdr3region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr3 region nucleotide sequence\n" - }, - "junction_sequence_nt_gapped": { - "type": "string", - "description": "gapped junction nucleotide sequence\n" - }, - "vdjregion_sequence_aa": { - "type": "string", - "description": "vdj region amino acid sequence\n" - }, - "vjregion_sequence_aa": { - "type": "string", - "description": "vj region amino acid sequence\n" - }, - "djregion_sequence_aa": { - "type": "string", - "description": "dj region amino acid sequence\n" - }, - "vregion_sequence_aa": { - "type": "string", - "description": "v region amino acid sequence\n" - }, - "dregion_sequence_aa": { - "type": "string", - "description": "d region amino acid sequence\n" - }, - "jregion_sequence_aa": { - "type": "string", - "description": "j region amino acid sequence\n" - }, - "fr1region_sequence_aa": { - "type": "string", - "description": "fr1 region amino acid sequence\n" - }, - "fr2region_sequence_aa": { - "type": "string", - "description": "fr2 region amino acid sequence\n" - }, - "fr3region_sequence_aa": { - "type": "string", - "description": "fr3 region amino acid sequence\n" - }, - "fr4region_sequence_aa": { - "type": "string", - "description": "fr4 region amino acid sequence\n" - }, - "cdr1region_sequence_aa": { - "type": "string", - "description": "cdr1 region amino acid sequence\n" - }, - "cdr2region_sequence_aa": { - "type": "string", - "description": "cdr2 region amino acid sequence\n" - }, - "cdr3region_sequence_aa": { - "type": "string", - "description": "cdr3 region amino acid sequence\n" - }, - "junction_sequence_aa": { - "type": "string", - "description": "junction amino acid sequence\n" - }, - "vdjregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped vdj region amino acid sequence\n" - }, - "vjregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped vj region amino acid sequence\n" - }, - "djregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped dj region amino acid sequence\n" - }, - "vregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped v region amino acid sequence\n" - }, - "dregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped d region amino acid sequence\n" - }, - "jregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped j region amino acid sequence\n" - }, - "fr1region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr1 region amino acid sequence\n" - }, - "fr2region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr2 region amino acid sequence\n" - }, - "fr3region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr3 region amino acid sequence\n" - }, - "fr4region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr4 region amino acid sequence\n" - }, - "cdr1region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr1 region amino acid sequence\n" - }, - "cdr2region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr2 region amino acid sequence\n" - }, - "cdr3region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr3 region amino acid sequence\n" - }, - "junction_sequence_aa_gapped": { - "type": "string", - "description": "gapped junction amino acid sequence\n" - }, - "vdjregion_start": { - "type": "integer", - "description": "e.g. 1\n" - }, - "vdjregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "vjregion_start": { - "type": "integer", - "description": "e.g. 0\n" - }, - "vjregion_end": { - "type": "integer", - "description": "e.g. 0\n" - }, - "djregion_start": { - "type": "integer", - "description": "e.g. 254\n" - }, - "djregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "vregion_start": { - "type": "integer", - "description": "e.g. 286\n" - }, - "vregion_end": { - "type": "integer", - "description": "e.g. 252\n" - }, - "dregion_start": { - "type": "integer", - "description": "e.g. 254\n" - }, - "dregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "jregion_start": { - "type": "integer", - "description": "e.g. 286\n" - }, - "jregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "fr1region_start": { - "type": "integer", - "description": "e.g. 1\n" - }, - "fr1region_end": { - "type": "integer", - "description": "e.g. 38\n" - }, - "fr2region_start": { - "type": "integer", - "description": "e.g. 63\n" - }, - "fr2region_end": { - "type": "integer", - "description": "e.g. 113\n" - }, - "fr3region_start": { - "type": "integer", - "description": "e.g. 135\n" - }, - "fr3region_end": { - "type": "integer", - "description": "e.g. 248\n" - }, - "fr4region_start": { - "type": "integer", - "description": "e.g. 288\n" - }, - "fr4region_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "cdr1region_start": { - "type": "integer", - "description": "e.g. 39\n" - }, - "cdr1region_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "cdr2region_start": { - "type": "integer", - "description": "e.g. 62\n" - }, - "cdr2region_end": { - "type": "integer", - "description": "e.g. 134\n" - }, - "cdr3region_start": { - "type": "integer", - "description": "e.g. 249\n" - }, - "cdr3region_end": { - "type": "integer", - "description": "e.g. 287\n" - }, - "junction_start": { - "type": "integer", - "description": "e.g. 246\n" - }, - "junction_end": { - "type": "integer", - "description": "e.g. 290\n" - }, - "vregion_mutation_string": { - "type": "string", - "description": "e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c|\n" - }, - "fr1region_mutation_string": { - "type": "string", - "description": "e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)|\n" - }, - "fr2region_mutation_string": { - "type": "string", - "description": "e.g. \n" - }, - "fr3region_mutation_string": { - "type": "string", - "description": "e.g. c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c|\"\n" - }, - "cdr1region_mutation_string": { - "type": "string", - "description": "e.g.\n" - }, - "cdr2region_mutation_string": { - "type": "string", - "description": "e.g. a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|\"\n" - }, - "cdr3region_mutation_string": { - "type": "string", - "description": "e.g. g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t\n" - }, - "citation": { - "type": "object", - "properties": { - "doi": { - "type": "string" - }, - "title": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "application/json": { - "seq_name": "M00930:18:000000000-A3782:1:1101:11543:3128_1:N:0\n", - "vgene_gene": "IGHV4-59\n", - "vgene_allele": "IGHV4-59*01 or IGHV4-59*07\n", - "dgene_string": "Homsap IGHD3-10*01 F\n", - "dgene_family": "IGHD3\n", - "dgene_gene": "IGHD3-10\n", - "dgene_allele": "IGHD3-10*01\n", - "jgene_string": "Homsap IGHJ4*02 F\n", - "jgene_family": "IGHJ4\n", - "jgene_gene": "IGHJ4\n", - "jgene_allele": "IGHJ4*02\n", - "functionality": "productive\n", - "vregion_mutation_string": "a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ -\n+)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- -\n-)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ +\n-)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c|\n", - "fr1region_mutation_string": "e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)|\n", - "fr3region_mutation_string": "c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+\n- +)|g275>c,S92>T(+ - +)|t279>c|\"\n", - "cdr2region_mutation_string": "a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|\"\n", - "cdr3region_mutation_string": "g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t\n", - "citation": { - "doi": "10.1093/cid/ciw767", - "title": "RNA-Seq Analysis of Gene Expression, Viral Pathogen, and B-Cell/T-Cell Receptor Signatures in Complex Chronic Disease.\n" - } - } + "$ref": "#/definitions/ireceptor_sequence_response" } }, "400": { @@ -2063,39 +1144,37 @@ ], "parameters": [ { - "name": "query", - "in": "body", - "schema": { - "type": "object", - "required": [ - "username" - ], - "properties": { - "username": { - "type": "string", - "description": "Username of the individual requesting access to the iReceptor repository node.\n" - }, - "project_sample_id_list": { - "type": "array", - "items": { - "type": "integer" - } - }, - "cdr3_length": { - "description": "length of complementarity determining region in nucleotide base pairs\n", - "type": "integer" - }, - "vgene_string": { - "type": "string" - }, - "jgene_string": { - "type": "string" - }, - "format": { - "description": "'csv' - vQuest based CSV (as per /v1); 'tsv' - vQuest based TSV (as per /v1 with tab delimiters instead of commas); 'airr' - AIRR Formats rearrangements TSV (as per AIRR formats rearrangements spec)" - } - } - } + "$ref": "#/parameters/ir_username_form" + }, + { + "$ref": "#/parameters/ir_sample_id_list_form" + }, + { + "$ref": "#/parameters/ir_data_format_form" + }, + { + "$ref": "#/parameters/v_call_form" + }, + { + "$ref": "#/parameters/d_call_form" + }, + { + "$ref": "#/parameters/j_call_form" + }, + { + "$ref": "#/parameters/junction_aa_form" + }, + { + "$ref": "#/parameters/junction_length_form" + }, + { + "$ref": "#/parameters/junction_aa_length_form" + }, + { + "$ref": "#/parameters/functional_form" + }, + { + "$ref": "#/parameters/ir_show_unproductive_form" } ], "operationId": "postSequenceData", @@ -2103,495 +1182,7 @@ "200": { "description": "A successful call returns an array of sequence data. Optional \"format\" parameter determines the output format. Default is a JSON response, limited to top 50 results. If \"format\" is set to \"csv\", it will return all the matching sequence annotations, in addition to sample information and annotation tool information, in a comma-separated format; \"tsv\" returns a tab-delimited outputs; \"airr\" returns AIRR minimal standards encoded tab-delimited outputs.\n", "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "seq_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "seq_name": { - "type": "string" - }, - "project_sample_id": { - "type": "integer", - "description": "e.g. 6\n" - }, - "id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "sequence_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "vgene_string": { - "type": "string" - }, - "vgene_family": { - "type": "string" - }, - "vgene_gene": { - "type": "string" - }, - "vgene_allele": { - "type": "string" - }, - "dgene_string": { - "type": "string" - }, - "dgene_family": { - "type": "string" - }, - "dgene_gene": { - "type": "string" - }, - "dgene_allele": { - "type": "string" - }, - "jgene_string": { - "type": "string" - }, - "jgene_family": { - "type": "string" - }, - "jgene_gene": { - "type": "string" - }, - "jgene_allele": { - "type": "string" - }, - "functionality": { - "type": "string" - }, - "functionality_comment": { - "type": "string", - "description": "e.g. \"\"\n" - }, - "orientation": { - "type": "string", - "description": "e.g. +\n" - }, - "vgene_score": { - "type": "integer", - "description": "e.g. 1127\n" - }, - "vgene_probability": { - "type": "integer", - "description": "e.g. 95\n" - }, - "dregion_reading_frame": { - "type": "integer", - "description": "e.g. 2\n" - }, - "cdr1_length": { - "type": "integer", - "description": "e.g. 8\n" - }, - "cdr2_length": { - "type": "integer", - "description": "e.g. 7\n" - }, - "cdr3_length": { - "type": "integer", - "description": "e.g. 13\n" - }, - "vdjregion_sequence_nt": { - "type": "string", - "description": "vdj region nucleotide sequence\n" - }, - "vjregion_sequence_nt": { - "type": "string", - "description": "vj region nucleotide sequence\n" - }, - "djregion_sequence_nt": { - "type": "string", - "description": "dj region nucleotide sequence\n" - }, - "vregion_sequence_nt": { - "type": "string", - "description": "v region nucleotide sequence\n" - }, - "dregion_sequence_nt": { - "type": "string", - "description": "d region nucleotide sequence\n" - }, - "jregion_sequence_nt": { - "type": "string", - "description": "j region nucleotide sequence\n" - }, - "fr1region_sequence_nt": { - "type": "string", - "description": "fr1 region nucleotide sequence\n" - }, - "fr2region_sequence_nt": { - "type": "string", - "description": "fr2 region nucleotide sequence\n" - }, - "fr3region_sequence_nt": { - "type": "string", - "description": "fr3 region nucleotide sequence\n" - }, - "fr4region_sequence_nt": { - "type": "string", - "description": "fr4 region nucleotide sequence\n" - }, - "cdr1region_sequence_nt": { - "type": "string", - "description": "cdr1 region nucleotide sequence\n" - }, - "cdr2region_sequence_nt": { - "type": "string", - "description": "cdr2 region nucleotide sequence\n" - }, - "cdr3region_sequence_nt": { - "type": "string", - "description": "cdr3 region nucleotide sequence\n" - }, - "junction_sequence_nt": { - "type": "string", - "description": "junction nucleotide sequence\n" - }, - "vdjregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped vdj region nucleotide sequence\n" - }, - "vjregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped vj region nucleotide sequence\n" - }, - "djregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped dj region nucleotide sequence\n" - }, - "vregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped v region nucleotide sequence\n" - }, - "dregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped d region nucleotide sequence\n" - }, - "jregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped j region nucleotide sequence\n" - }, - "fr1region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr1 region nucleotide sequence\n" - }, - "fr2region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr2 region nucleotide sequence\n" - }, - "fr3region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr3 region nucleotide sequence\n" - }, - "fr4region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr4 region nucleotide sequence\n" - }, - "cdr1region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr1 region nucleotide sequence\n" - }, - "cdr2region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr2 region nucleotide sequence\n" - }, - "cdr3region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr3 region nucleotide sequence\n" - }, - "junction_sequence_nt_gapped": { - "type": "string", - "description": "gapped junction nucleotide sequence\n" - }, - "vdjregion_sequence_aa": { - "type": "string", - "description": "vdj region amino acid sequence\n" - }, - "vjregion_sequence_aa": { - "type": "string", - "description": "vj region amino acid sequence\n" - }, - "djregion_sequence_aa": { - "type": "string", - "description": "dj region amino acid sequence\n" - }, - "vregion_sequence_aa": { - "type": "string", - "description": "v region amino acid sequence\n" - }, - "dregion_sequence_aa": { - "type": "string", - "description": "d region amino acid sequence\n" - }, - "jregion_sequence_aa": { - "type": "string", - "description": "j region amino acid sequence\n" - }, - "fr1region_sequence_aa": { - "type": "string", - "description": "fr1 region amino acid sequence\n" - }, - "fr2region_sequence_aa": { - "type": "string", - "description": "fr2 region amino acid sequence\n" - }, - "fr3region_sequence_aa": { - "type": "string", - "description": "fr3 region amino acid sequence\n" - }, - "fr4region_sequence_aa": { - "type": "string", - "description": "fr4 region amino acid sequence\n" - }, - "cdr1region_sequence_aa": { - "type": "string", - "description": "cdr1 region amino acid sequence\n" - }, - "cdr2region_sequence_aa": { - "type": "string", - "description": "cdr2 region amino acid sequence\n" - }, - "cdr3region_sequence_aa": { - "type": "string", - "description": "cdr3 region amino acid sequence\n" - }, - "junction_sequence_aa": { - "type": "string", - "description": "junction amino acid sequence\n" - }, - "vdjregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped vdj region amino acid sequence\n" - }, - "vjregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped vj region amino acid sequence\n" - }, - "djregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped dj region amino acid sequence\n" - }, - "vregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped v region amino acid sequence\n" - }, - "dregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped d region amino acid sequence\n" - }, - "jregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped j region amino acid sequence\n" - }, - "fr1region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr1 region amino acid sequence\n" - }, - "fr2region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr2 region amino acid sequence\n" - }, - "fr3region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr3 region amino acid sequence\n" - }, - "fr4region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr4 region amino acid sequence\n" - }, - "cdr1region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr1 region amino acid sequence\n" - }, - "cdr2region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr2 region amino acid sequence\n" - }, - "cdr3region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr3 region amino acid sequence\n" - }, - "junction_sequence_aa_gapped": { - "type": "string", - "description": "gapped junction amino acid sequence\n" - }, - "vdjregion_start": { - "type": "integer", - "description": "e.g. 1\n" - }, - "vdjregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "vjregion_start": { - "type": "integer", - "description": "e.g. 0\n" - }, - "vjregion_end": { - "type": "integer", - "description": "e.g. 0\n" - }, - "djregion_start": { - "type": "integer", - "description": "e.g. 254\n" - }, - "djregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "vregion_start": { - "type": "integer", - "description": "e.g. 286\n" - }, - "vregion_end": { - "type": "integer", - "description": "e.g. 252\n" - }, - "dregion_start": { - "type": "integer", - "description": "e.g. 254\n" - }, - "dregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "jregion_start": { - "type": "integer", - "description": "e.g. 286\n" - }, - "jregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "fr1region_start": { - "type": "integer", - "description": "e.g. 1\n" - }, - "fr1region_end": { - "type": "integer", - "description": "e.g. 38\n" - }, - "fr2region_start": { - "type": "integer", - "description": "e.g. 63\n" - }, - "fr2region_end": { - "type": "integer", - "description": "e.g. 113\n" - }, - "fr3region_start": { - "type": "integer", - "description": "e.g. 135\n" - }, - "fr3region_end": { - "type": "integer", - "description": "e.g. 248\n" - }, - "fr4region_start": { - "type": "integer", - "description": "e.g. 288\n" - }, - "fr4region_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "cdr1region_start": { - "type": "integer", - "description": "e.g. 39\n" - }, - "cdr1region_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "cdr2region_start": { - "type": "integer", - "description": "e.g. 62\n" - }, - "cdr2region_end": { - "type": "integer", - "description": "e.g. 134\n" - }, - "cdr3region_start": { - "type": "integer", - "description": "e.g. 249\n" - }, - "cdr3region_end": { - "type": "integer", - "description": "e.g. 287\n" - }, - "junction_start": { - "type": "integer", - "description": "e.g. 246\n" - }, - "junction_end": { - "type": "integer", - "description": "e.g. 290\n" - }, - "vregion_mutation_string": { - "type": "string" - }, - "fr1region_mutation_string": { - "type": "string" - }, - "fr2region_mutation_string": { - "type": "string" - }, - "fr3region_mutation_string": { - "type": "string" - }, - "cdr1region_mutation_string": { - "type": "string" - }, - "cdr2region_mutation_string": { - "type": "string" - }, - "cdr3region_mutation_string": { - "type": "string" - }, - "citation": { - "type": "object", - "properties": { - "doi": { - "type": "string" - }, - "title": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "application/json": { - "seq_name": "M00930:18:000000000-A3782:1:1101:11543:3128_1:N:0\n", - "vgene_gene": "IGHV4-59\n", - "vgene_allele": "IGHV4-59*01 or IGHV4-59*07\n", - "dgene_string": "Homsap IGHD3-10*01 F\n", - "dgene_family": "IGHD3\n", - "dgene_gene": "IGHD3-10\n", - "dgene_allele": "IGHD3-10*01\n", - "jgene_string": "Homsap IGHJ4*02 F\n", - "jgene_family": "IGHJ4\n", - "jgene_gene": "IGHJ4\n", - "jgene_allele": "IGHJ4*02\n", - "functionality": "productive\n", - "vregion_mutation_string": "a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ -\n+)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- -\n-)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ +\n-)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c|\n", - "fr1region_mutation_string": "e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)|\n", - "fr3region_mutation_string": "c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+\n- +)|g275>c,S92>T(+ - +)|t279>c|\"\n", - "cdr2region_mutation_string": "a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|\"\n", - "cdr3region_mutation_string": "g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t\n", - "citation": { - "doi": "10.1093/cid/ciw767", - "title": "RNA-Seq Analysis of Gene Expression, Viral Pathogen, and B-Cell/T-Cell Receptor Signatures in Complex Chronic Disease.\n" - } - } + "$ref": "#/definitions/ireceptor_sequence_response" } }, "400": { @@ -2613,65 +1204,56 @@ } }, "/clones_summary": { - "get": { + "x-swagger-router-controller": "clones", + "post": { "description": "This service returns a summary of sequence clones that match the GET provided filter. \"username\" parameter refers to external_users table.\n", "tags": [ "clones" ], "parameters": [ { - "name": "username", - "in": "query", - "description": "Username of the individual requesting access to the iReceptor repository node.\n", - "required": true, - "type": "string" + "$ref": "#/parameters/ir_username_form" }, { - "name": "project_sample_id_list", - "in": "query", - "required": true, - "type": "array", - "items": { - "type": "integer" - } + "$ref": "#/parameters/ir_sample_id_list_form" }, { - "name": "cdr3_length", - "in": "query", - "description": "length of complementarity determining region in nucleotide base pairs", - "required": false, - "type": "integer" + "$ref": "#/parameters/v_call_form" }, { - "name": "vgene_string", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/d_call_form" }, { - "name": "jgene_string", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/j_call_form" + }, + { + "$ref": "#/parameters/junction_aa_form" + }, + { + "$ref": "#/parameters/junction_length_form" + }, + { + "$ref": "#/parameters/junction_aa_length_form" + }, + { + "$ref": "#/parameters/functional_form" + }, + { + "$ref": "#/parameters/ir_show_unproductive_form" } ], - "operationId": "getCloneSummary", + "operationId": "postCloneSummary", "responses": { "200": { "description": "A successful call returns an summary of clone data as an array of 'category' = count pairs in which the 'category' are string tags of parameters of interest from a controlled vocabulary term set.\n", "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "category": { - "type": "string", - "description": "e.g. samples\n" - }, - "count": { - "type": "integer", - "description": "e.g. 100\n" - } + "type": "object", + "properties": { + "summary": { + "$ref": "#/definitions/ireceptor_sequence_summary_response" + }, + "items": { + "$ref": "#/definitions/ireceptor_sequence_response" } } } @@ -2695,561 +1277,53 @@ } }, "/clones_data": { - "get": { + "x-swagger-router-controller": "clones", + "post": { "description": "This service returns a list of clones that matches the GET provided filter. \"username\" parameter refers to external_users table.\n", "tags": [ "clones" ], "parameters": [ { - "name": "username", - "in": "query", - "description": "Username of the individual requesting access to the iReceptor repository node.\n", - "required": true, - "type": "string" + "$ref": "#/parameters/ir_username_form" }, { - "name": "project_sample_id_list", - "in": "query", - "required": true, - "type": "array", - "items": { - "type": "integer" - } + "$ref": "#/parameters/ir_sample_id_list_form" }, { - "name": "cdr3_length", - "in": "query", - "description": "length of complementarity determining region in nucleotide base pairs", - "required": false, - "type": "integer" + "$ref": "#/parameters/ir_data_format_form" }, { - "name": "vgene_string", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/v_call_form" }, { - "name": "jgene_string", - "in": "query", - "required": false, - "type": "string" + "$ref": "#/parameters/d_call_form" + }, + { + "$ref": "#/parameters/j_call_form" + }, + { + "$ref": "#/parameters/junction_aa_form" + }, + { + "$ref": "#/parameters/junction_length_form" + }, + { + "$ref": "#/parameters/junction_aa_length_form" + }, + { + "$ref": "#/parameters/functional_form" + }, + { + "$ref": "#/parameters/ir_show_unproductive_form" } ], - "operationId": "getCloneData", + "operationId": "postCloneData", "responses": { "200": { "description": "A successful call returns an array of sequence data. Optional \"output\" parameter determines the output format. Default is a JSON response, limited to top 50 results. If \"output\" is set to \"csv\", it will return all the matching sequence annotations, in addition to sample information and annotation tool information, in a comma-separated format. \n", "schema": { - "type": "array", - "items": { - "type": "object", - "properties": { - "seq_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "seq_name": { - "type": "string" - }, - "project_sample_id": { - "type": "integer", - "description": "e.g. 6\n" - }, - "id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "sequence_id": { - "type": "integer", - "description": "e.g. 1\n" - }, - "vgene_string": { - "type": "string" - }, - "vgene_family": { - "type": "string", - "description": "e.g. IGHV4\n" - }, - "vgene_gene": { - "type": "string", - "description": "e.g. IGHV4-59\n" - }, - "vgene_allele": { - "type": "string", - "description": "e.g. IGHV4-59*01 or IGHV4-59*07\n" - }, - "dgene_string": { - "type": "string", - "description": "e.g. Homsap IGHD3-10*01 F\n" - }, - "dgene_family": { - "type": "string", - "description": "e.g. IGHD3\n" - }, - "dgene_gene": { - "type": "string", - "description": "e.g. IGHD3-10\n" - }, - "dgene_allele": { - "type": "string", - "description": "e.g. IGHD3-10*01\n" - }, - "jgene_string": { - "type": "string", - "description": "e.g. Homsap IGHJ4*02 F\n" - }, - "jgene_family": { - "type": "string", - "description": "e.g. IGHJ4\n" - }, - "jgene_gene": { - "type": "string", - "description": "e.g. IGHJ4\n" - }, - "jgene_allele": { - "type": "string", - "description": "e.g. IGHJ4*02\n" - }, - "functionality": { - "type": "string", - "description": "e.g. productive\n" - }, - "functionality_comment": { - "type": "string", - "description": "e.g. \"\"\n" - }, - "orientation": { - "type": "string", - "description": "e.g. +\n" - }, - "vgene_score": { - "type": "integer", - "description": "e.g. 1127\n" - }, - "vgene_probability": { - "type": "integer", - "description": "e.g. 95\n" - }, - "dregion_reading_frame": { - "type": "integer", - "description": "e.g. 2\n" - }, - "cdr1_length": { - "type": "integer", - "description": "e.g. 8\n" - }, - "cdr2_length": { - "type": "integer", - "description": "e.g. 7\n" - }, - "cdr3_length": { - "type": "integer", - "description": "e.g. 13\n" - }, - "vdjregion_sequence_nt": { - "type": "string", - "description": "vdj region nucleotide sequence\n" - }, - "vjregion_sequence_nt": { - "type": "string", - "description": "vj region nucleotide sequence\n" - }, - "djregion_sequence_nt": { - "type": "string", - "description": "dj region nucleotide sequence\n" - }, - "vregion_sequence_nt": { - "type": "string", - "description": "v region nucleotide sequence\n" - }, - "dregion_sequence_nt": { - "type": "string", - "description": "d region nucleotide sequence\n" - }, - "jregion_sequence_nt": { - "type": "string", - "description": "j region nucleotide sequence\n" - }, - "fr1region_sequence_nt": { - "type": "string", - "description": "fr1 region nucleotide sequence\n" - }, - "fr2region_sequence_nt": { - "type": "string", - "description": "fr2 region nucleotide sequence\n" - }, - "fr3region_sequence_nt": { - "type": "string", - "description": "fr3 region nucleotide sequence\n" - }, - "fr4region_sequence_nt": { - "type": "string", - "description": "fr4 region nucleotide sequence\n" - }, - "cdr1region_sequence_nt": { - "type": "string", - "description": "cdr1 region nucleotide sequence\n" - }, - "cdr2region_sequence_nt": { - "type": "string", - "description": "cdr2 region nucleotide sequence\n" - }, - "cdr3region_sequence_nt": { - "type": "string", - "description": "cdr3 region nucleotide sequence\n" - }, - "junction_sequence_nt": { - "type": "string", - "description": "junction nucleotide sequence\n" - }, - "vdjregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped vdj region nucleotide sequence\n" - }, - "vjregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped vj region nucleotide sequence\n" - }, - "djregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped dj region nucleotide sequence\n" - }, - "vregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped v region nucleotide sequence\n" - }, - "dregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped d region nucleotide sequence\n" - }, - "jregion_sequence_nt_gapped": { - "type": "string", - "description": "gapped j region nucleotide sequence\n" - }, - "fr1region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr1 region nucleotide sequence\n" - }, - "fr2region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr2 region nucleotide sequence\n" - }, - "fr3region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr3 region nucleotide sequence\n" - }, - "fr4region_sequence_nt_gapped": { - "type": "string", - "description": "gapped fr4 region nucleotide sequence\n" - }, - "cdr1region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr1 region nucleotide sequence\n" - }, - "cdr2region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr2 region nucleotide sequence\n" - }, - "cdr3region_sequence_nt_gapped": { - "type": "string", - "description": "gapped cdr3 region nucleotide sequence\n" - }, - "junction_sequence_nt_gapped": { - "type": "string", - "description": "gapped junction nucleotide sequence\n" - }, - "vdjregion_sequence_aa": { - "type": "string", - "description": "vdj region amino acid sequence\n" - }, - "vjregion_sequence_aa": { - "type": "string", - "description": "vj region amino acid sequence\n" - }, - "djregion_sequence_aa": { - "type": "string", - "description": "dj region amino acid sequence\n" - }, - "vregion_sequence_aa": { - "type": "string", - "description": "v region amino acid sequence\n" - }, - "dregion_sequence_aa": { - "type": "string", - "description": "d region amino acid sequence\n" - }, - "jregion_sequence_aa": { - "type": "string", - "description": "j region amino acid sequence\n" - }, - "fr1region_sequence_aa": { - "type": "string", - "description": "fr1 region amino acid sequence\n" - }, - "fr2region_sequence_aa": { - "type": "string", - "description": "fr2 region amino acid sequence\n" - }, - "fr3region_sequence_aa": { - "type": "string", - "description": "fr3 region amino acid sequence\n" - }, - "fr4region_sequence_aa": { - "type": "string", - "description": "fr4 region amino acid sequence\n" - }, - "cdr1region_sequence_aa": { - "type": "string", - "description": "cdr1 region amino acid sequence\n" - }, - "cdr2region_sequence_aa": { - "type": "string", - "description": "cdr2 region amino acid sequence\n" - }, - "cdr3region_sequence_aa": { - "type": "string", - "description": "cdr3 region amino acid sequence\n" - }, - "junction_sequence_aa": { - "type": "string", - "description": "junction amino acid sequence\n" - }, - "vdjregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped vdj region amino acid sequence\n" - }, - "vjregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped vj region amino acid sequence\n" - }, - "djregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped dj region amino acid sequence\n" - }, - "vregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped v region amino acid sequence\n" - }, - "dregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped d region amino acid sequence\n" - }, - "jregion_sequence_aa_gapped": { - "type": "string", - "description": "gapped j region amino acid sequence\n" - }, - "fr1region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr1 region amino acid sequence\n" - }, - "fr2region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr2 region amino acid sequence\n" - }, - "fr3region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr3 region amino acid sequence\n" - }, - "fr4region_sequence_aa_gapped": { - "type": "string", - "description": "gapped fr4 region amino acid sequence\n" - }, - "cdr1region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr1 region amino acid sequence\n" - }, - "cdr2region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr2 region amino acid sequence\n" - }, - "cdr3region_sequence_aa_gapped": { - "type": "string", - "description": "gapped cdr3 region amino acid sequence\n" - }, - "junction_sequence_aa_gapped": { - "type": "string", - "description": "gapped junction amino acid sequence\n" - }, - "vdjregion_start": { - "type": "integer", - "description": "e.g. 1\n" - }, - "vdjregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "vjregion_start": { - "type": "integer", - "description": "e.g. 0\n" - }, - "vjregion_end": { - "type": "integer", - "description": "e.g. 0\n" - }, - "djregion_start": { - "type": "integer", - "description": "e.g. 254\n" - }, - "djregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "vregion_start": { - "type": "integer", - "description": "e.g. 286\n" - }, - "vregion_end": { - "type": "integer", - "description": "e.g. 252\n" - }, - "dregion_start": { - "type": "integer", - "description": "e.g. 254\n" - }, - "dregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "jregion_start": { - "type": "integer", - "description": "e.g. 286\n" - }, - "jregion_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "fr1region_start": { - "type": "integer", - "description": "e.g. 1\n" - }, - "fr1region_end": { - "type": "integer", - "description": "e.g. 38\n" - }, - "fr2region_start": { - "type": "integer", - "description": "e.g. 63\n" - }, - "fr2region_end": { - "type": "integer", - "description": "e.g. 113\n" - }, - "fr3region_start": { - "type": "integer", - "description": "e.g. 135\n" - }, - "fr3region_end": { - "type": "integer", - "description": "e.g. 248\n" - }, - "fr4region_start": { - "type": "integer", - "description": "e.g. 288\n" - }, - "fr4region_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "cdr1region_start": { - "type": "integer", - "description": "e.g. 39\n" - }, - "cdr1region_end": { - "type": "integer", - "description": "e.g. 321\n" - }, - "cdr2region_start": { - "type": "integer", - "description": "e.g. 62\n" - }, - "cdr2region_end": { - "type": "integer", - "description": "e.g. 134\n" - }, - "cdr3region_start": { - "type": "integer", - "description": "e.g. 249\n" - }, - "cdr3region_end": { - "type": "integer", - "description": "e.g. 287\n" - }, - "junction_start": { - "type": "integer", - "description": "e.g. 246\n" - }, - "junction_end": { - "type": "integer", - "description": "e.g. 290\n" - }, - "vregion_mutation_string": { - "type": "string", - "description": "e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c|\n" - }, - "fr1region_mutation_string": { - "type": "string", - "description": "e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)|\n" - }, - "fr2region_mutation_string": { - "type": "string", - "description": "e.g. \n" - }, - "fr3region_mutation_string": { - "type": "string", - "description": "e.g. c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c|\"\n" - }, - "cdr1region_mutation_string": { - "type": "string", - "description": "e.g.\n" - }, - "cdr2region_mutation_string": { - "type": "string", - "description": "e.g. a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|\"\n" - }, - "cdr3region_mutation_string": { - "type": "string", - "description": "e.g. g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t\n" - }, - "citation": { - "type": "object", - "properties": { - "doi": { - "type": "string" - }, - "title": { - "type": "string" - } - } - } - } - } - }, - "examples": { - "application/json": { - "seq_name": "M00930:18:000000000-A3782:1:1101:11543:3128_1:N:0\n", - "vgene_gene": "IGHV4-59\n", - "vgene_allele": "IGHV4-59*01 or IGHV4-59*07\n", - "dgene_string": "Homsap IGHD3-10*01 F\n", - "dgene_family": "IGHD3\n", - "dgene_gene": "IGHD3-10\n", - "dgene_allele": "IGHD3-10*01\n", - "jgene_string": "Homsap IGHJ4*02 F\n", - "jgene_family": "IGHJ4\n", - "jgene_gene": "IGHJ4\n", - "jgene_allele": "IGHJ4*02\n", - "functionality": "productive\n", - "vregion_mutation_string": "a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ -\n+)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- -\n-)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ +\n-)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c|\n", - "fr1region_mutation_string": "e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)|\n", - "fr3region_mutation_string": "c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+\n- +)|g275>c,S92>T(+ - +)|t279>c|\"\n", - "cdr2region_mutation_string": "a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|\"\n", - "cdr3region_mutation_string": "g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t\n", - "citation": { - "doi": "10.1093/cid/ciw767", - "title": "RNA-Seq Analysis of Gene Expression, Viral Pathogen, and B-Cell/T-Cell Receptor Signatures in Complex Chronic Disease.\n" - } - } + "$ref": "#/definitions/ireceptor_sequence_response" } }, "400": { diff --git a/iReceptor_Data_Service_API_V2.yaml b/iReceptor_Data_Service_API_V2.yaml index eed031d..ccda0d5 100644 --- a/iReceptor_Data_Service_API_V2.yaml +++ b/iReceptor_Data_Service_API_V2.yaml @@ -1,25 +1,633 @@ swagger: '2.0' info: title: iReceptor Data Source API - version: 2.0.4 + version: 2.0.5 contact: name: iReceptor Project url: 'http://www.ireceptor.org/' email: breden@sfu.ca description: > Documentation of Major Version 2 of the iReceptor Adaptive Immune Receptor - Repertoire (AIRR) data source web service application programming interface (API). - V2 of the API implements an increased level of compliance with the [Minimal - Information for AIRR (MiAIRR) standard](https://github.com/airr-community/airr-standards). - Learn more about [iReceptor](http://www.ireceptor.org/) + Repertoire (AIRR) data repsoitory web service application programming interface + (API). V2 of the API implements an increased level of compliance with the + [Minimal Information for AIRR (MiAIRR) + standard](https://github.com/airr-community/airr-standards). Learn more + about [iReceptor](http://www.ireceptor.org/) host: ipa.ireceptor.org basePath: /v2 +definitions: + # A definition of the summary response for an iReceptor API call. This + # response is used wherever summary data at the sample level is provided + # by an API call. It is composed of the sequence count, the relevant AIRR + # model elements, and the revelant iReceptor model elements. + ireceptor_sample_summary_response: + type: array + items: + allOf: + - $ref: '#/definitions/ireceptor_sequence_count_model' + - $ref: '#/definitions/airr_summary_model' + - $ref: 'https://raw.githubusercontent.com/sfu-ireceptor/api/AIRR-compliance/ireceptor_summary.yaml#/ireceptor_summary_model' + ireceptor_sequence_summary_response: + type: array + items: + allOf: + - $ref: '#/definitions/ireceptor_sequence_count_model' + - $ref: '#/definitions/ireceptor_filtered_sequence_count_model' + - $ref: '#/definitions/airr_summary_model' + - $ref: 'https://raw.githubusercontent.com/sfu-ireceptor/api/AIRR-compliance/ireceptor_summary.yaml#/ireceptor_summary_model' + # A definition of the sequence response for an iReceptor API call. This + # response is used wherever sequence data is provided by an API call. + # It is a composite of the sequence fields defined by the MiAIRR standard, + # the sequence fields defined by the AIRR Formats working group, and any + # ancillary fields defined by iReceptor. + ireceptor_sequence_response: + type: array + items: + allOf: + - $ref: 'https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/Rearrangement' + - $ref: 'https://raw.githubusercontent.com/sfu-ireceptor/api/AIRR-compliance/ireceptor_sequence.yaml#/ireceptor_sequence_annotation_model' + # The AIRR Minimal Standards model for metadata above the sequence annotation level. + airr_summary_model: + allOf: + - $ref: 'https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/Study' + - $ref: 'https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/Subject' + - $ref: 'https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/Diagnosis' + - $ref: 'https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/Sample' + - $ref: 'https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/CellProcessing' + - $ref: 'https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/NucleicAcidProcessing' + - $ref: 'https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/RawSequenceData' + - $ref: 'https://raw.githubusercontent.com/airr-community/airr-standards/v0.1.0/specs/definitions.yaml#/SoftwareProcessing' + # A simple model to represent a sequence count, used to make the + # composite responses clean in that they all refer to models. + ireceptor_sequence_count_model: + type: object + properties: + ir_sequence_count: + type: integer + description: Number of sequences found that met the sample search criteria for this sample + example: 123456 + ireceptor_filtered_sequence_count_model: + type: object + properties: + ir_filtered_sequence_count: + type: integer + description: Number of sequences found that met the sequence search criteria for this sample + example: 4321 + ireceptor_core_samples_parameters_model: + type: object + required: + - ir_username + properties: + ir_username: + type: string + description: > + Username of the individual requesting access to the iReceptor + repository node. + ir_lab_id: + type: string + description: | + e.g. 1 + ir_project_id: + type: array + items: + type: string + description: | + e.g. 1 + ireceptor_ancillary_samples_parameters_model: + type: object + properties: + ir_subject_age_min: + type: integer + description: | + e.g. 30 + ir_subject_age_max: + type: integer + description: | + e.g. 50 + # + # AIRR Formats compliant extended parameters for rearrangements (/sequences* entry points) + # + airr_formats_sequences_parameters_model: + type: object + properties: + junction_length: + type: integer + description: | + Number of junction nucleotides in sequence_vdj (CDR3 + conserved residues) + junction_aa_length: + type: integer + description: >- + Length of JUNCTION in amino acids + functional: + type: string + description: | + Filter for sequences that are either functional, non-functional, or both + # + # iReceptor extensions to the MiAIRR and AIRR Formats parameter models. + # + ireceptor_core_sequences_parameters_model: + type: object + required: + - ir_username + properties: + ir_username: + type: string + description: > + Username of the individual requesting access to the iReceptor + repository node. + ir_project_sample_id_list: + type: array + items: + type: string + ir_data_format: + description: >- + 'csv' - vQuest based CSV (as per /v1); 'tsv' - vQuest based + TSV (as per /v1 with tab delimiters instead of commas); 'airr' + - AIRR Formats rearrangements TSV (as per AIRR formats + rearrangements spec) + ireceptor_ancillary_sequences_parameters_model: + type: object + properties: + ir_show_unproductive: + type: string + description: >- + By default, only productive sequences are returned. In order to return + unproductive sequences, set this parameter to "T" + +parameters: + # + # Generally useful parameters for all API entry points. + # + ir_username: + name: ir_username + in: query + description: > + Username of the individual requesting access to the iReceptor + repository node. If the iReceptor repository is a public repository, + then this parameter is not required. If the repository is not public + then the username must be supplied and the repository will determine + the access for that user for that repository. + required: false + type: string + ir_username_form: + name: ir_username + in: formData + description: > + Username of the individual requesting access to the iReceptor + repository node. If the iReceptor repository is a public repository, + then this parameter is not required. If the repository is not public + then the username must be supplied and the repository will determine + the access for that user for that repository. + required: false + type: string + # + # MiAIRR compliant parameters for /samples entry points. + # Note: Currently only those parameters used by iReceptor repositories + # are defined here. + # + study_id: + name: study_id + type: string + in: query + study_id_form: + name: study_id + type: string + in: formData + study_title: + name: study_title + type: string + in: query + study_title_form: + name: study_title + type: string + in: formData + study_description: + name: study_description + type: string + in: query + study_description_form: + name: study_description + type: string + in: formData + lab_name: + name: lab_name + type: string + in: query + lab_name_form: + name: lab_name + type: string + in: formData + subject_id: + name: subject_id + type: string + in: query + subject_id_form: + name: subject_id + type: string + in: formData + organism: + name: organism + type: string + in: query + organism_form: + name: organism + type: string + in: formData + sex: + name: sex + type: string + in: query + sex_form: + name: sex + type: string + in: formData + ethnicity: + name: ethnicity + type: array + items: + type: string + in: query + ethnicity_form: + name: ethnicity + type: array + items: + type: string + in: formData + study_group_description: + name: study_group_description + type: array + items: + type: string + in: query + study_group_description_form: + name: study_group_description + type: array + items: + type: string + in: formData + sample_id: + name: sample_id + type: string + in: query + sample_id_form: + name: sample_id + type: string + in: formData + tissue: + name: tissue + type: array + items: + type: string + in: query + tissue_form: + name: tissue + type: array + items: + type: string + in: formData + disease_state_sample: + name: disease_state_sample + type: string + in: query + disease_state_sample_form: + name: disease_state_sample + type: string + in: formData + cell_subset: + name: cell_subset + type: array + items: + type: string + in: query + cell_subset_form: + name: cell_subset + type: array + items: + type: string + in: formData + cell_phenotype: + name: cell_phenotype + type: string + in: query + cell_phenotype_form: + name: cell_phenotype + type: string + in: formData + template_class: + name: template_class + type: array + items: + type: string + in: query + template_class_form: + name: template_class + type: array + items: + type: string + in: formData + sequencing_platform: + name: sequencing_platform + type: string + in: query + sequencing_platform_form: + name: sequencing_platform + type: string + in: formData + # + # iReceptor specific parameters for the /samples API entry point. + # + ir_project_id: + name: ir_project_id + in: query + description: | + e.g. 1 + required: false + type: array + items: + type: string + ir_project_id_form: + name: ir_project_id + in: formData + description: | + e.g. 1 + required: false + type: array + items: + type: string + ir_subject_age_min: + name: ir_subject_age_min + in: query + description: | + e.g. 10 + required: false + type: integer + ir_subject_age_min_form: + name: ir_subject_age_min + in: formData + description: | + e.g. 10 + required: false + type: integer + ir_subject_age_max: + name: ir_subject_age_max + in: query + description: | + e.g. 12 + required: false + type: integer + ir_subject_age_max_form: + name: ir_subject_age_max + in: formData + description: | + e.g. 12 + required: false + type: integer + # + # MiAIRR compliant parameters for rearrangements (/sequences* entry points) + # + germline_database: + name: germline_database + in: query + type: string + description: > + Source of germline V(D)J segments, with version number or + date accessed (e.g. IMGT/V-QUEST Release 201736-4 (7 September 2017)) (AIRR) + germline_database_form: + name: germline_database + in: formData + type: string + description: > + Source of germline V(D)J segments, with version number or + date accessed (e.g. IMGT/V-QUEST Release 201736-4 (7 September 2017)) (AIRR) + cell_index: + name: cell_index + in: query + type: integer + description: | + Cell Index (UID linking sequences from the same cell) (AIRR) + cell_index_form: + name: cell_index + in: formData + type: integer + description: | + Cell Index (UID linking sequences from the same cell) (AIRR) + v_call: + name: v_call + in: query + type: string + description: | + V gene with allele (e.g. IGHV4-59*01) (AIRR) + v_call_form: + name: v_call + in: formData + type: string + description: | + V gene with allele (e.g. IGHV4-59*01) (AIRR) + d_call: + name: d_call + in: query + type: string + description: | + D gene with allele (e.g. IGHD3-10*01) (AIRR) + d_call_form: + name: d_call + in: formData + type: string + description: | + D gene with allele (e.g. IGHD3-10*01) (AIRR) + j_call: + name: j_call + in: query + type: string + description: | + J gene with allele (e.g. IGHJ4*02) (AIRR) + j_call_form: + name: j_call + in: formData + type: string + description: | + J gene with allele (e.g. IGHJ4*02) (AIRR) + c_call: + name: c_call + in: query + type: string + description: | + C region with allele (AIRR) + c_call_form: + name: c_call + in: formData + type: string + description: | + C region with allele (AIRR) + junction_nt: + name: junction_nt + in: query + type: string + description: > + JUNCTION nucleotide sequence (Sequence of the CDR3 + region + conserved residues (nucleotide)) (AIRR) + junction_nt_form: + name: junction_nt + in: formData + type: string + description: > + JUNCTION nucleotide sequence (Sequence of the CDR3 + region + conserved residues (nucleotide)) (AIRR) + junction_aa: + name: junction_aa + in: query + type: string + description: > + JUNCTION amino acid sequence (Sequence of the CDR3 + region + conserved residues (amino acid)) (AIRR) + junction_aa_form: + name: junction_aa + in: formData + type: string + description: > + JUNCTION amino acid sequence (Sequence of the CDR3 + region + conserved residues (amino acid)) (AIRR) + duplicate_count: + name: duplicate_count + in: query + type: integer + description: | + Number of times the sequence has been duplicated in a file (AIRR) + duplicate_count_form: + name: duplicate_count + in: formData + type: integer + description: | + Number of times the sequence has been duplicated in a file (AIRR) + # + # AIRR Formats compliant extended parameters for rearrangements (/sequences* entry points) + # + junction_length: + name: junction_length + in: query + type: integer + description: | + Number of junction nucleotides in sequence_vdj (CDR3 + conserved residues) + junction_length_form: + name: junction_length + in: formData + type: integer + description: | + Number of junction nucleotides in sequence_vdj (CDR3 + conserved residues) + junction_aa_length: + name: junction_aa_length + in: query + description: >- + Length of JUNCTION (CDR3 + conserved residues) in amino acids + required: false + type: integer + junction_aa_length_form: + name: junction_aa_length + in: formData + description: >- + Length of JUNCTION (CDR3 + conserved residues) in amino acids + required: false + type: integer + functional: + name: functional + in: query + type: boolean + default: true + description: | + Filter for sequences that are either functional, non-functional, or both + functional_form: + name: functional + in: formData + type: boolean + default: true + description: | + Filter for sequences that are either functional, non-functional, or both + # + # iReceptor specific parameters for rearrangements (/sequences* entry points) + # + ir_sample_id_list: + name: ir_project_sample_id_list + in: query + description: > + List of unique identifiers (specific to the repository) that identify the samples + to apply the query to. + required: false + type: array + items: + type: string + ir_sample_id_list_form: + name: ir_project_sample_id_list + in: formData + description: > + List of unique identifiers (specific to the repository) that identify the samples + to apply the query to. + required: false + type: array + items: + type: string + ir_data_format: + name: ir_data_format + in: query + description: >- + Data format to return the sequence data in, one of:
+ 'csv' - vQuest based CSV (as per /v1)(default)
+ 'tsv' - vQuest based TSV (as per /v1 with tab delimiters instead of commas);
+ 'airr' - AIRR Formats rearrangements TSV (as per AIRR formats rearrangements spec) + required: false + type: string + ir_data_format_form: + name: ir_data_format + in: formData + description: >- + Data format to return the sequence data in, one of:
+ 'csv' - vQuest based CSV (as per /v1)(default)
+ 'tsv' - vQuest based TSV (as per /v1 with tab delimiters instead of commas);
+ 'airr' - AIRR Formats rearrangements TSV (as per AIRR formats rearrangements spec) + required: false + type: string + ir_show_unproductive: + name: ir_show_unproductive + in: query + description: > + By default, only productive sequences are returned. In order to return + unproductive sequences, set this parameter to "T" + required: false + type: array + items: + type: boolean + ir_show_unproductive_form: + name: ir_show_unproductive + in: formData + description: > + By default, only productive sequences are returned. In order to return + unproductive sequences, set this parameter to "T" + required: false + type: array + items: + type: boolean + ir_junction_nt_length: + name: ir_junction_nt_length + in: query + description: >- + Length of JUNCTION (CDR3 + conserved residues) in nucleotide base pairs (iReceptor) + required: false + type: integer + ir_junction_nt_length_form: + name: ir_junction_nt_length + in: formData + description: >- + Length of JUNCTION (CDR3 + conserved residues) in nucleotide base pairs (iReceptor) + required: false + type: integer schemes: - - http - https produces: - application/json +consumes: + - application/x-www-form-urlencoded tags: + - name: info + description: Service information - name: samples description: Queries for samples - name: sequences @@ -27,271 +635,90 @@ tags: - name: clones description: Queries for clones paths: + /: + x-swagger-router-controller: status + get: + description: | + Service heartbeat. + operationId: getStatus + responses: + '200': + description: | + Success. + schema: + type: object + properties: + result: + type: string + /info: + x-swagger-router-controller: status + get: + description: | + Service information. + tags: + - info + operationId: getInfo + responses: + '200': + description: | + Success. + schema: + type: object + properties: + name: + type: string + version: + type: string + /swagger: + x-swagger-pipe: swagger_raw /samples: + x-swagger-router-controller: samples get: description: > This service returns metadata about samples, including higher-level meta-data around the study, subject, diagnosis, and sample processing - (data relevant to MiAIRR data classes 1 through 3). The data - returned is filtered based on the parameters provided. + (data relevant to MiAIRR data classes 1 through 3). The data returned is + filtered based on the parameters provided. A successful call returns a json list with a sample level summary of - each sample including a summary count of the number of sequences found for - that sample. + each sample including a summary count of the number of sequences found + for that sample. tags: - samples parameters: - - name: username - in: query - description: > - Username of the individual requesting access to the iReceptor - repository node. - required: true - type: string - - name: lab_id - in: query - description: | - e.g. 1 - required: false - type: integer - - name: project_id - in: query - description: | - e.g. 1 - required: false - type: array - items: - type: integer - - name: subject_code - in: query - description: | - e.g. test - required: false - type: string - - name: subject_gender - in: query - description: | - e.g. Male or Female - required: false - type: string - - name: subject_species - in: query - description: | - e.g. Human - required: false - type: string - - name: subject_ethnicity - in: query - description: | - e.g. Caucasian - required: false - type: string - - name: subject_age_min - in: query - description: | - e.g. 10 - required: false - type: integer - - name: subject_age_max - in: query - description: | - e.g. 12 - required: false - type: integer - - name: case_control_name - in: query - description: | - e.g. Control - required: false - type: string - - name: sample_name - in: query - description: | - e.g. test2 - required: false - type: string - - name: sample_source_name - in: query - description: | - e.g. Blood (PBMC) - required: false - type: string - - name: ireceptor_cell_subset_name - in: query - description: | - e.g. NaiveB - required: false - type: string - - name: dna_type - in: query - description: | - e.g. cDNA, gDNA - required: false - type: string + - $ref: '#/parameters/ir_username' + - $ref: '#/parameters/ir_project_id' + - $ref: '#/parameters/study_id' + - $ref: '#/parameters/study_title' + - $ref: '#/parameters/study_description' + - $ref: '#/parameters/lab_name' + - $ref: '#/parameters/subject_id' + - $ref: '#/parameters/organism' + - $ref: '#/parameters/sex' + - $ref: '#/parameters/ethnicity' + - $ref: '#/parameters/study_group_description' + - $ref: '#/parameters/sample_id' + - $ref: '#/parameters/tissue' + - $ref: '#/parameters/disease_state_sample' + - $ref: '#/parameters/cell_subset' + - $ref: '#/parameters/cell_phenotype' + - $ref: '#/parameters/template_class' + - $ref: '#/parameters/sequencing_platform' + - $ref: '#/parameters/ir_subject_age_min' + - $ref: '#/parameters/ir_subject_age_max' operationId: getSamples responses: '200': description: | - A successful call returns the metadata for each sample, including - the number of sequences found for that sample. + A successful call returns an array of sample summary metadata for + each sample that meets the search criteria. The metadata returned + for each sample includes the number of sequences found for that sample + as well as the study/subject/sample data for that sample. The metadata + for each sample in the response contains a set of AIRR compliant data + as well as repository specific data that is required to query the + repository about those types of elements. schema: - type: array - items: - type: object - properties: - sequence_count: - type: integer - description: | - e.g. 0 - subject_code: - type: string - description: | - e.g. Subject One - subject_id: - type: integer - description: | - e.g. 1 - subject_gender: - type: string - description: | - e.g. Male - subject_ethnicity: - type: string - description: | - e.g. Eth1 - subject_age: - type: integer - description: | - e.g. 1 - project_id: - type: integer - description: | - e.g. 0 - study_title: - type: string - description: | - Publication or Protocol Title (e.g. My Study) (AIRR)(v1 = project_name) - study_type: - type: string - description: | - Type of project/study (e.g. Cancer) (AIRR)(v1 = project_type) - project_parent_id: - type: integer - description: | - e.g. null - lab_id: - type: integer - description: | - e.g. 0 - lab_name: - type: string - description: | - Name of the Laboratory running the study (AIRR) - case_control_id: - type: integer - description: | - e.g. 0 - case_control_name: - type: string - description: | - e.g. Control - sample_id: - type: integer - description: | - e.g. 0 - sample_name: - type: string - description: | - e.g. Blood Sample 01 - project_sample_id: - type: integer - description: | - e.g. 0 - sample_subject_id: - type: integer - description: | - e.g. 0 - dna_id: - type: integer - description: | - e.g. 0 - dna_type: - type: string - description: | - e.g. cDNA - sample_source_id: - type: integer - description: | - e.g. 0 - sample_source_name: - type: string - description: | - e.g. Blood (PBMC) - lab_cell_subset_name: - type: string - description: | - e.g. Naive B Alpha - ireceptor_cell_subset_name: - type: string - description: | - e.g. Naive B - marker_1: - type: string - description: | - e.g. CR19 - marker_2: - type: string - description: | - e.g. CR20 - marker_3: - type: string - description: | - e.g. CR21 - marker_4: - type: string - description: | - e.g. null - marker_5: - type: string - description: | - e.g. null - marker_6: - type: string - description: | - e.g. null - examples: - application/json: - - sequence_count: 1234567 - subject_code: Subject One - subject_id: 1 - subject_gender: Male - subject_ethnicity: Caucasian - subject_species: Human - project_id: 0 - study_title: First Project - study_type: Cancer - project_parent_id: null - lab_id: 0 - lab_name: First Lab - case_control_id: 0 - case_control_name: Control - sample_id: 1 - project_sample_id: 1 - sample_name: Blood Sample 01 - subject_age: 22 - sample_subject_id: 1 - dna_id: 1 - dna_type: cDNA - sample_source_id: 2 - sample_source_name: Blood (PBMC) - lab_cell_subset_name: Naive B Alpha - ireceptor_cell_subset_name: Naive B - marker_1: CR19 - marker_2: CR20 - marker_3: CR21 - marker_4: null - marker_5: null - marker_6: null + $ref: '#/definitions/ireceptor_sample_summary_response' '400': description: malformed request '401': @@ -306,256 +733,48 @@ paths: description: > This service returns metadata about samples, including higher-level meta-data around the study, subject, diagnosis, and sample processing - (data relevant to MiAIRR data classes 1 through 3). The data - returned is filtered based on the parameters provided. + (data relevant to MiAIRR data classes 1 through 3). The data returned is + filtered based on the parameters provided. A successful call returns a json list with a sample level summary of - each sample including a summary count of the number of sequences found for - that sample. + each sample including a summary count of the number of sequences found + for that sample. tags: - samples parameters: - - name: query - in: body - required: true - schema: - type: object - required: - - username - properties: - username: - type: string - description: > - Username of the individual requesting access to the iReceptor - repository node. - lab_id: - type: integer - description: | - e.g. 1 - project_id: - type: array - items: - type: integer - description: | - e.g. 1 - subject_code: - type: string - description: | - e.g. test - subject_gender: - type: string - description: | - e.g. Male - subject_ethnicity: - type: string - description: | - e.g. Caucasian - subject_species: - type: string - description: | - e.g. Human - subject_age_min: - type: integer - description: | - e.g. 10 - subject_age_max: - type: integer - description: | - e.g. 12 - case_control_name: - type: string - description: | - e.g. Control - sample_name: - type: string - description: | - e.g. test2 - sample_source_name: - type: array - items: - type: string - description: | - e.g. Blood (PBMC) - ireceptor_cell_subset_name: - type: array - items: - type: string - description: | - e.g. NaiveB - dna_type: - type: array - items: - type: string - description: | - e.g. cDNA + - $ref: '#/parameters/ir_username_form' + - $ref: '#/parameters/ir_project_id_form' + - $ref: '#/parameters/study_id_form' + - $ref: '#/parameters/study_title_form' + - $ref: '#/parameters/study_description_form' + - $ref: '#/parameters/lab_name_form' + - $ref: '#/parameters/subject_id_form' + - $ref: '#/parameters/organism_form' + - $ref: '#/parameters/sex_form' + - $ref: '#/parameters/ethnicity_form' + - $ref: '#/parameters/study_group_description_form' + - $ref: '#/parameters/sample_id_form' + - $ref: '#/parameters/tissue_form' + - $ref: '#/parameters/disease_state_sample_form' + - $ref: '#/parameters/cell_subset_form' + - $ref: '#/parameters/cell_phenotype_form' + - $ref: '#/parameters/template_class_form' + - $ref: '#/parameters/sequencing_platform_form' + - $ref: '#/parameters/ir_subject_age_min_form' + - $ref: '#/parameters/ir_subject_age_max_form' operationId: postSamples responses: '200': - description: | - A successful call returns the metadata for each sample, including - the number of sequences found for that sample. + description: > + A successful call returns an array of sample summary metadata for + each sample that meets the search criteria. The metadata returned + for each sample includes the number of sequences found for that sample + as well as the study/subject/sample data for that sample. The metadata + for each sample in the response contains a set of AIRR compliant data + as well as repository specific data that is required to query the + repository about those types of elements. schema: - type: array - items: - type: object - properties: - subject_code: - type: string - description: | - e.g. Subject One - subject_id: - type: integer - description: | - e.g. 1 - subject_gender: - type: string - description: | - e.g. Male - subject_ethnicity: - type: string - description: | - e.g. Caucasian - subject_species: - type: string - description: | - e.g. Human - subject_age: - type: integer - description: | - e.g. 1 - project_id: - type: integer - description: | - e.g. 0 - study_title: - type: string - description: | - Publication or Protocol Title (e.g. My Study) (AIRR)(v1 = project_name) - study_type: - type: string - description: | - Type of project/study (e.g. Cancer) (AIRR)(v1 = project_type) - project_parent_id: - type: integer - description: | - e.g. null - lab_id: - type: integer - description: | - e.g. 0 - lab_name: - type: string - description: | - Name of the Laboratory running the study (AIRR) - case_control_id: - type: integer - description: | - e.g. 0 - case_control_name: - type: string - description: | - e.g. Control - sample_id: - type: integer - description: | - e.g. 0 - sample_name: - type: string - description: | - e.g. Blood Sample 01 - project_sample_id: - type: integer - description: | - e.g. 0 - sample_subject_id: - type: integer - description: | - e.g. 0 - sequence_count: - type: integer - description: | - e.g. 0 - dna_id: - type: integer - description: | - e.g. 0 - dna_type: - type: string - description: | - e.g. cDNA - sample_source_id: - type: integer - description: | - e.g. 0 - sample_source_name: - type: string - description: | - e.g. Blood (PBMC) - lab_cell_subset_name: - type: string - description: | - e.g. Naive B Alpha - ireceptor_cell_subset_name: - type: string - description: | - e.g. Naive B - marker_1: - type: string - description: | - e.g. CR19 - marker_2: - type: string - description: | - e.g. CR20 - marker_3: - type: string - description: | - e.g. CR21 - marker_4: - type: string - description: | - e.g. null - marker_5: - type: string - description: | - e.g. null - marker_6: - type: string - description: | - e.g. null - examples: - application/json: - - sequence_count: 1234567 - subject_code: Subject One - subject_id: 1 - subject_gender: Male - subject_ethnicity: Caucasian - subject_species: Human - project_id: 0 - study_title: First Project - study_type: Cancer - project_parent_id: null - lab_id: 0 - lab_name: First Lab - case_control_id: 0 - case_control_name: Control - sample_id: 1 - project_sample_id: 1 - sample_name: Blood Sample 01 - subject_age: 22 - sample_subject_id: 1 - dna_id: 1 - dna_type: cDNA - sample_source_id: 2 - sample_source_name: Blood (PBMC) - lab_cell_subset_name: Naive B Alpha - ireceptor_cell_subset_name: Naive B - marker_1: CR19 - marker_2: CR20 - marker_3: CR21 - marker_4: null - marker_5: null - marker_6: null + $ref: '#/definitions/ireceptor_sample_summary_response' '400': description: malformed request '401': @@ -567,853 +786,93 @@ paths: '405': description: method not allowed /sequences_summary: + x-swagger-router-controller: sequences get: description: > This service returns a summary of sequences that matches the GET - provided filter. "username" parameter refers to external_users table. + provided filter. "ir_username" parameter refers to user requesting + access to the repository. tags: - sequences parameters: - - name: username - in: query - description: > - Username of the individual requesting access to the iReceptor - repository node. - required: true - type: string - - name: project_sample_id_list - in: query - required: true - type: array - items: - type: integer - - name: cdr3_length - in: query - description: >- - length of complementarity determining region in nucleotide base - pairs - required: false - type: integer - - name: vgene_string - in: query - required: false - type: string - - name: jgene_string - in: query - required: false - type: string + - $ref: '#/parameters/ir_username' + - $ref: '#/parameters/ir_sample_id_list' + - $ref: '#/parameters/v_call' + - $ref: '#/parameters/d_call' + - $ref: '#/parameters/j_call' + - $ref: '#/parameters/junction_aa' + - $ref: '#/parameters/junction_length' + - $ref: '#/parameters/junction_aa_length' + - $ref: '#/parameters/functional' + - $ref: '#/parameters/ir_show_unproductive' operationId: getSequenceSummary responses: '200': description: > - A successful call returns an summary of sequence data as an array of - 'category' = count pairs in which the 'category' are string tags of - parameters of interest from a controlled vocabulary term set. + A successful call returns two components, an aggregated summary of the data + that satisfies the query and an example subset of the annotated sequence data + that meets the query criteria. The aggreated data returns a summary similar + to that returned by the /samples API entry point, returning the number of + sequences and the study/subject/sample meta-data for each sample. The example + subset of sequence data that is returned is a small subset of annotated sequences + that met the search criteria. The number of sequences returned is given in the + "num_sequences" paramter to the query and the format in which the sequences are + returned is provided by the "sequence_format" parameter to the query. + schema: + type: object + properties: + summary: + $ref: '#/definitions/ireceptor_sequence_summary_response' + items: + $ref: '#/definitions/ireceptor_sequence_response' + '400': + description: malformed request + '401': + description: authentication error + '403': + description: authorization error + '404': + description: data not found + '405': + description: method not allowed + post: + description: > + This service returns a summary of sequences that matches the POST + provided filter. "ir_username" parameter refers to user requesting + access to the repository. + tags: + - sequences + parameters: + - $ref: '#/parameters/ir_username_form' + - $ref: '#/parameters/ir_sample_id_list_form' + - $ref: '#/parameters/v_call_form' + - $ref: '#/parameters/d_call_form' + - $ref: '#/parameters/j_call_form' + - $ref: '#/parameters/junction_aa_form' + - $ref: '#/parameters/junction_length_form' + - $ref: '#/parameters/junction_aa_length_form' + - $ref: '#/parameters/functional_form' + - $ref: '#/parameters/ir_show_unproductive_form' + operationId: postSequenceSummary + responses: + '200': + description: > + A successful call returns two components, an aggregated summary of the data + that satisfies the query and an example subset of the annotated sequence data + that meets the query criteria. The aggreated data returns a summary similar + to that returned by the /samples API entry point, returning the number of + sequences and the study/subject/sample meta-data for each sample. The example + subset of sequence data that is returned is a small subset of annotated sequences + that met the search criteria. The number of sequences returned is given in the + "num_sequences" paramter to the query and the format in which the sequences are + returned is provided by the "sequence_format" parameter to the query. schema: type: object properties: - aggregation_summary: - type: array - items: - type: object - properties: - subject_code: - type: string - description: | - e.g. Subject One - subject_id: - type: integer - description: | - e.g. 1 - subject_gender: - type: string - description: | - e.g. Male - subject_species: - type: string - description: | - e.g. Mouse - subject_ethnicity: - type: string - description: | - e.g. Eth1 - subject_age: - type: integer - description: | - e.g. 1 - project_id: - type: integer - description: | - e.g. 0 - study_title: - type: string - description: | - Publication or Protocol Title (e.g. My Study) (AIRR)(v1 = project_name) - study_type: - type: string - description: | - Type of project/study (e.g. Cancer) (AIRR)(v1 = project_type) - project_parent_id: - type: integer - description: | - e.g. null - study: - type: string - description: | - Alphanumeric UID assigned by NCBI (e.g. PRJNA349) (AIRR)(sra_accession) - lab_id: - type: integer - description: | - e.g. 0 - lab_name: - type: string - description: | - Name of the Laboratory running the study (AIRR) - disease_state_id: - type: integer - description: | - e.g. 1 - disease_state_name: - type: string - description: | - e.g. HIV-1 infected - case_control_id: - type: integer - description: | - e.g. 0 - case_control_name: - type: string - description: | - e.g. Control - sample_id: - type: integer - description: | - e.g. 0 - sample_name: - type: string - description: | - e.g. Blood Sample 01 - project_sample_id: - type: integer - description: | - e.g. 0 - sample_subject_id: - type: integer - description: | - e.g. 0 - sequence_count: - type: integer - description: | - e.g. 0 - dna_id: - type: integer - description: | - e.g. 0 - dna_type: - type: string - description: | - e.g. cDNA - sample_source_id: - type: integer - description: | - e.g. 0 - sample_source_name: - type: string - description: | - e.g. Blood (PBMC) - lab_cell_subset_name: - type: string - description: | - e.g. Naive B Alpha - ireceptor_cell_subset_name: - type: string - description: | - e.g. Naive B - marker_1: - type: string - description: | - e.g. CR19 - marker_2: - type: string - description: | - e.g. CR20 - marker_3: - type: string - description: | - e.g. CR21 - marker_4: - type: string - description: | - e.g. null - marker_5: - type: string - description: | - e.g. null - marker_6: - type: string - description: | - e.g. null - sequences: - type: integer - description: | - e.g. 167793 - sequences: - type: array - items: - type: object - properties: - seq_id: - type: integer - description: | - e.g. 1 - seq_name: - type: string - project_sample_id: - type: integer - description: | - e.g. 6 - id: - type: integer - description: | - e.g. 1 - sequence_id: - type: integer - description: | - e.g. 1 - vgene_string: - type: string - description: | - e.g IGHV4-59*01 or IGHV4-59*07 - vgene_family: - type: string - description: | - e.g. IGHV4 - vgene_gene: - type: string - description: | - e.g. IGHV4-59 - vgene_allele: - type: string - description: | - e.g. IGHV4-59*01 or IGHV4-59*07 - dgene_string: - type: string - description: | - e.g. Homsap IGHD3-10*01 F - dgene_family: - type: string - description: | - e.g. IGHD3 - dgene_gene: - type: string - description: | - e.g. IGHD3-10 - dgene_allele: - type: string - description: | - e.g. IGHD3-10*01 - jgene_string: - type: string - description: | - e.g. Homsap IGHJ4*02 F - jgene_family: - type: string - description: | - e.g. IGHJ4 - jgene_gene: - type: string - description: | - e.g. IGHJ4 - jgene_allele: - type: string - description: | - e.g. IGHJ4*02 - functionality: - type: string - description: | - e.g. productive - functionality_comment: - type: string - description: | - e.g. "" - orientation: - type: string - description: | - e.g. + - vgene_score: - type: integer - description: | - e.g. 1127 - vgene_probability: - type: integer - description: | - e.g. 95 - dregion_reading_frame: - type: integer - description: | - e.g. 2 - cdr1_length: - type: integer - description: | - e.g. 8 - cdr2_length: - type: integer - description: | - e.g. 7 - cdr3_length: - type: integer - description: | - e.g. 13 - vdjregion_sequence_nt: - type: string - description: | - vdj region nucleotide sequence - vjregion_sequence_nt: - type: string - description: | - vj region nucleotide sequence - djregion_sequence_nt: - type: string - description: | - dj region nucleotide sequence - vregion_sequence_nt: - type: string - description: | - v region nucleotide sequence - dregion_sequence_nt: - type: string - description: | - d region nucleotide sequence - jregion_sequence_nt: - type: string - description: | - j region nucleotide sequence - fr1region_sequence_nt: - type: string - description: | - fr1 region nucleotide sequence - fr2region_sequence_nt: - type: string - description: | - fr2 region nucleotide sequence - fr3region_sequence_nt: - type: string - description: | - fr3 region nucleotide sequence - fr4region_sequence_nt: - type: string - description: | - fr4 region nucleotide sequence - cdr1region_sequence_nt: - type: string - description: | - cdr1 region nucleotide sequence - cdr2region_sequence_nt: - type: string - description: | - cdr2 region nucleotide sequence - cdr3region_sequence_nt: - type: string - description: | - cdr3 region nucleotide sequence - junction_sequence_nt: - type: string - description: | - junction nucleotide sequence - vdjregion_sequence_nt_gapped: - type: string - description: | - gapped vdj region nucleotide sequence - vjregion_sequence_nt_gapped: - type: string - description: | - gapped vj region nucleotide sequence - djregion_sequence_nt_gapped: - type: string - description: | - gapped dj region nucleotide sequence - vregion_sequence_nt_gapped: - type: string - description: | - gapped v region nucleotide sequence - dregion_sequence_nt_gapped: - type: string - description: | - gapped d region nucleotide sequence - jregion_sequence_nt_gapped: - type: string - description: | - gapped j region nucleotide sequence - fr1region_sequence_nt_gapped: - type: string - description: | - gapped fr1 region nucleotide sequence - fr2region_sequence_nt_gapped: - type: string - description: | - gapped fr2 region nucleotide sequence - fr3region_sequence_nt_gapped: - type: string - description: | - gapped fr3 region nucleotide sequence - fr4region_sequence_nt_gapped: - type: string - description: | - gapped fr4 region nucleotide sequence - cdr1region_sequence_nt_gapped: - type: string - description: | - gapped cdr1 region nucleotide sequence - cdr2region_sequence_nt_gapped: - type: string - description: | - gapped cdr2 region nucleotide sequence - cdr3region_sequence_nt_gapped: - type: string - description: | - gapped cdr3 region nucleotide sequence - junction_sequence_nt_gapped: - type: string - description: | - gapped junction nucleotide sequence - vdjregion_sequence_aa: - type: string - description: | - vdj region amino acid sequence - vjregion_sequence_aa: - type: string - description: | - vj region amino acid sequence - djregion_sequence_aa: - type: string - description: | - dj region amino acid sequence - vregion_sequence_aa: - type: string - description: | - v region amino acid sequence - dregion_sequence_aa: - type: string - description: | - d region amino acid sequence - jregion_sequence_aa: - type: string - description: | - j region amino acid sequence - fr1region_sequence_aa: - type: string - description: | - fr1 region amino acid sequence - fr2region_sequence_aa: - type: string - description: | - fr2 region amino acid sequence - fr3region_sequence_aa: - type: string - description: | - fr3 region amino acid sequence - fr4region_sequence_aa: - type: string - description: | - fr4 region amino acid sequence - cdr1region_sequence_aa: - type: string - description: | - cdr1 region amino acid sequence - cdr2region_sequence_aa: - type: string - description: | - cdr2 region amino acid sequence - cdr3region_sequence_aa: - type: string - description: | - cdr3 region amino acid sequence - junction_sequence_aa: - type: string - description: | - junction amino acid sequence - vdjregion_sequence_aa_gapped: - type: string - description: | - gapped vdj region amino acid sequence - vjregion_sequence_aa_gapped: - type: string - description: | - gapped vj region amino acid sequence - djregion_sequence_aa_gapped: - type: string - description: | - gapped dj region amino acid sequence - vregion_sequence_aa_gapped: - type: string - description: | - gapped v region amino acid sequence - dregion_sequence_aa_gapped: - type: string - description: | - gapped d region amino acid sequence - jregion_sequence_aa_gapped: - type: string - description: | - gapped j region amino acid sequence - fr1region_sequence_aa_gapped: - type: string - description: | - gapped fr1 region amino acid sequence - fr2region_sequence_aa_gapped: - type: string - description: | - gapped fr2 region amino acid sequence - fr3region_sequence_aa_gapped: - type: string - description: | - gapped fr3 region amino acid sequence - fr4region_sequence_aa_gapped: - type: string - description: | - gapped fr4 region amino acid sequence - cdr1region_sequence_aa_gapped: - type: string - description: | - gapped cdr1 region amino acid sequence - cdr2region_sequence_aa_gapped: - type: string - description: | - gapped cdr2 region amino acid sequence - cdr3region_sequence_aa_gapped: - type: string - description: | - gapped cdr3 region amino acid sequence - junction_sequence_aa_gapped: - type: string - description: | - gapped junction amino acid sequence - vdjregion_start: - type: integer - description: | - e.g. 1 - vdjregion_end: - type: integer - description: | - e.g. 321 - vjregion_start: - type: integer - description: | - e.g. 0 - vjregion_end: - type: integer - description: | - e.g. 0 - djregion_start: - type: integer - description: | - e.g. 254 - djregion_end: - type: integer - description: | - e.g. 321 - vregion_start: - type: integer - description: | - e.g. 286 - vregion_end: - type: integer - description: | - e.g. 252 - dregion_start: - type: integer - description: | - e.g. 254 - dregion_end: - type: integer - description: | - e.g. 321 - jregion_start: - type: integer - description: | - e.g. 286 - jregion_end: - type: integer - description: | - e.g. 321 - fr1region_start: - type: integer - description: | - e.g. 1 - fr1region_end: - type: integer - description: | - e.g. 38 - fr2region_start: - type: integer - description: | - e.g. 63 - fr2region_end: - type: integer - description: | - e.g. 113 - fr3region_start: - type: integer - description: | - e.g. 135 - fr3region_end: - type: integer - description: | - e.g. 248 - fr4region_start: - type: integer - description: | - e.g. 288 - fr4region_end: - type: integer - description: | - e.g. 321 - cdr1region_start: - type: integer - description: | - e.g. 39 - cdr1region_end: - type: integer - description: | - e.g. 321 - cdr2region_start: - type: integer - description: | - e.g. 62 - cdr2region_end: - type: integer - description: | - e.g. 134 - cdr3region_start: - type: integer - description: | - e.g. 249 - cdr3region_end: - type: integer - description: | - e.g. 287 - junction_start: - type: integer - description: | - e.g. 246 - junction_end: - type: integer - description: | - e.g. 290 - vregion_mutation_string: - type: string - description: > - e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - - +)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- - - -)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ + - -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c| - fr1region_mutation_string: - type: string - description: | - e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)| - fr2region_mutation_string: - type: string - description: | - e.g. - fr3region_mutation_string: - type: string - description: > - e.g. c198>g,N66>K(+ - -)|a220>g,S74>G(+ + - -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c|" - cdr1region_mutation_string: - type: string - description: | - e.g. - cdr2region_mutation_string: - type: string - description: | - e.g. a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|" - cdr3region_mutation_string: - type: string - description: | - e.g. g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t - annotation_tool: - type: string - description: | - e.g. VQuest - examples: - application/json: - aggregation_summary: - - subject_code: IAVI 84 - subject_id: 1 - subject_gender: null - subject_ethnicity: NA - subject_species: Homo Sapiens - project_id: 1 - study_title: >- - Mining the antibodyome for HIV-1 neutralizing antibodies - with next generation sequencing and phylogenetic pairing of - heavy/light chains - study_type: HIV - project_parent_id: -1 - study: SRP018335 - lab_id: 1 - lab_name: National Institute of Allergy and Infectious -DiseaseVaccine - Research Center: Kwong Lab - disease_state_id: 7 - disease_state_name: >- - HIV-1 infected for at least 3 years, not receiving - antiretroviral treatment - case_control_id: 1 - case_control_name: Case - sample_id: 1 - project_sample_id: 1 - sequence_count: 253684 - project_sample_note: null - sra_run_id: SRR654169 - sample_name: SRS388604 - subject_age: null - sample_subject_id: 1 - dna_id: 1 - dna_type: cDNA - sample_source_id: 1 - sample_source_name: PBMCs - lab_cell_subset_name: B cell memory - ireceptor_cell_subset_name: Memory B Cell - marker_1: IgG+ - marker_2: CD19+ - marker_3: sIgG+ - marker_4: ' negative depletion to CD3' - marker_5: ' CD14' - marker_6: ' CD16, IgM, IgA, IgD ' - sequences: 167793 - sequences: - - seq_id: 2 - seq_name: SRR654169.17_G912ZWU01EPN4E_length=379 - project_sample_id: 1 - id: 37 - vgene_string: Homsap IGHV1-24*01 F - vgene_family: IGHV1 - vgene_gene: IGHV1-24 - vgene_allele: ' IGHV1-24*01 ' - jgene_string: Homsap IGHJ3*02 F - jgene_family: IGHJ3 - jgene_gene: IGHJ3 - jgene_allele: ' IGHJ3*02 ' - dgene_string: Homsap IGHD3-22*01 F - dgene_family: IGHD3 - dgene_gene: IGHD3-22 - dgene_allele: ' IGHD3-22*01 ' - functionality: productive - vgene_score: 1417 - vgene_probablity: null - dregion_reading_frame: '3' - cdr1_length: 8 - cdr2_length: 8 - cdr3_length: 17 - vdjregion_sequence_nt: >- - caggtccagctggtagagtctggggctgaggtgaagaagcctggggcctcagtgaaggtctcctgcaagtttccggatacaccctcactgaattatccatgcactgggtgcgacaggctcctggaaaagggcttgatggatgggaggttttgatcctgaagatggtgaaacaatctacgcacagaagttccagggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgtgcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatctggggccaagggacaatggtcaccgtctcttcag - vjregion_sequence_nt: '' - djregion_sequence_nt: >- - gatagttgtgattatggacgatggttttgatatctggggccaagggacaatggtcaccgtctcttcag - vregion_sequence_nt: >- - caggtccagctggtagagtctggggctgaggtgaagaagcctggggcctcagtgaaggtctcctgcaaggtttccggatacaccctcactgaattatccatgcactgggtgcgacaggctcctggaaaagggcttgagtggatgggaggttttgatcctgaagatggtgaaacaatctacgcacagaagttccagggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgtgcaaca - jregion_sequence_nt: gatggttttgatatctggggccaagggacaatggtcaccgtctcttcag - dregion_sequence_nt: gatagttgtgattat - fr1region_sequence_nt: >- - caggtccagctggtagagtctggggctgaggtgaagaagcctggggcctcagtgaaggtctcctgcaaggtttcc - fr2region_sequence_nt: atgcactgggtgcgacaggctcctggaaaagggcttgagtggatgggaggt - fr3region_sequence_nt: >- - atctacgcacagaagttccagggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgt - fr4region_sequence_nt: tggggccaagggacaatggtcaccgtctcttcag - cdr1region_sequence_nt: ggatacaccctcactgaattatcc - cdr2region_sequence_nt: tttgatcctgaagatggtgaaaca - cdr3region_sequence_nt: gcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatc - junction_sequence_nt: tgtgcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatctgg - vdjregion_sequence_nt_gapped: >- - caggtccagctggtagagtctggggct...gaggtgaagaagcctggggcctcagtgaaggtctcctgcaaggtttccggatacaccctc............actgaattatccatgcactgggtgcgacaggctcctggaaaagggcttgagtggatgggaggttttgatcctgaa......gatggtgaaacaatctacgcacagaagttccag...ggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgtgcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatctggggccaagggacaatggtcaccgtctcttcag - vjregion_sequence_nt_gapped: '' - djregion_sequence_nt_gapped: null - vregion_sequence_nt_gapped: >- - caggtccagctggtagagtctggggct...gaggtgaagaagcctggggcctcagtgaaggtctcctgcaaggtttccggatacaccctc............actgaattatccatgcactgggtgcgacaggctcctggaaaagggcttgagtggatgggaggttttgatcctgaa......gatggtgaaacaatctacgcacagaagttccag...ggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgtgcaaca - jregion_sequence_nt_gapped: gatggttttgatatctggggccaagggacaatggtcaccgtctcttcag - dregion_sequence_nt_gapped: gatggttttgatatctggggccaagggacaatggtcaccgtctcttcag - fr1region_sequence_nt_gapped: >- - caggtccagctggtagagtctggggct - ...gaggtgaagaagcctggggcctcagtgaaggtctcctgcaaggtttcc - fr2region_sequence_nt_gapped: atgcactgggtgcgacaggctcctggaaaagggcttgagtggatgggaggt - fr3region_sequence_nt_gapped: >- - atctacgcacagaagttccag...ggcagaatcaccatgaccgaggacacatctacagacacagcctacatggagctgagcagcctgagatctgaggacacggccgtgtattactgt - fr4region_sequence_nt_gapped: tggggccaagggacaatggtcaccgtctcttcag - cdr1region_sequence_nt_gapped: ggatacaccctc............actgaattatcc - cdr2region_sequence_nt_gapped: tttgatcctgaa......gatggtgaaaca - cdr3region_sequence_nt_gapped: gcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatc - junction_sequence_nt_gapped: tgtgcaacaaggagtcctccgatagttgtgattatggacgatggttttgatatctgg - vdjregion_sequence_aa: >- - QVQLVESGAEVKKPGASVKVSCKVSGYTLTELSMHWVRQAPGKGLEWMGGFDPEDGETIYAQKFQGR - ITMTEDTSTDTAYMELSSLRSEDTAVYYCATRSPPIVVIMDDGFDIWGQGTMVTVSS - vjregion_sequence_aa: '' - djregion_sequence_aa: null - vregion_sequence_aa: >- - QVQLVESGAEVKKPGASVKVSCKVSGYTLTELSMHWVRQAPGKGLEWMGGFDPEDGETIYAQKFQGRITMTEDTSTDTAYMELSSLRSEDTAVYYCAT - jregion_sequence_aa: DGFDIWGQGTMVTVSS - dregion_sequence_aa: null - fr1region_sequence_aa: QVQLVESGAEVKKPGASVKVSCKVS - fr2region_sequence_aa: MHWVRQAPGKGLEWMGG - fr3region_sequence_aa: IYAQKFQGRITMTEDTSTDTAYMELSSLRSEDTAVYYC - fr4region_sequence_aa: WGQGTMVTVSS - cdr1region_sequence_aa: GYTLTELS - cdr2region_sequence_aa: FDPEDGET - cdr3region_sequence_aa: ATRSPPIVVIMDDGFDI - junction_sequence_aa: CATRSPPIVVIMDDGFDIW - vdjregion_sequence_aa_gapped: >- - QVQLVESGA.EVKKPGASVKVSCKVSGYTL....TELSMHWVRQAPGKGLEWMGGFDPE..DGETIYAQKFQ.GRITMTEDTSTDTAYMELSSLRSEDTAVYYCATRSPPIVVIMDDGFDIWGQGTMVTVSS - vjregion_sequence_aa_gapped: '' - djregion_sequence_aa_gapped: null - vregion_sequence_aa_gapped: >- - QVQLVESGA.EVKKPGASVKVSCKVSGYTL....TELSMHWVRQAPGKGLEWMGGFDPE..DGETIYAQKFQ.GRITMTEDTSTDTAYMELSSLRSEDTAVYYCAT - jregion_sequence_aa_gapped: DGFDIWGQGTMVTVSS - dregion_sequence_aa_gapped: null - fr1region_sequence_aa_gapped: QVQLVESGA.EVKKPGASVKVSCKVS - fr2region_sequence_aa_gapped: MHWVRQAPGKGLEWMGG - fr3region_sequence_aa_gapped: IYAQKFQ.GRITMTEDTSTDTAYMELSSLRSEDTAVYYC - fr4region_sequence_aa_gapped: WGQGTMVTVSS - cdr1region_sequence_aa_gapped: GYTL....TELS - cdr2region_sequence_aa_gapped: FDPE..DGET - cdr3region_sequence_aa_gapped: ATRSPPIVVIMDDGFDI - junction_sequence_aa_gapped: CATRSPPIVVIMDDGFDIW - vdjregion_start: 2 - vdjregion_end: 374 - vjregion_start: null - vjregion_end: null - vregion_start: 2 - vregion_end: 295 - jregion_start: 326 - jregion_end: 374 - dregion_start: 307 - dregion_end: 374 - fr1region_start: 2 - fr1region_end: 76 - fr2region_start: 101 - fr2region_end: 151 - fr3region_start: 176 - fr3region_end: 289 - fr4region_start: 341 - fr4region_end: 374 - cdr1region_start: 77 - cdr1region_end: 100 - cdr2region_start: 152 - cdr2region_end: 175 - cdr3region_start: 290 - cdr3region_end: 340 - junction_start: 287 - junction_end: 343 - vregion_mutation_string: 'c16>g,Q6>E(++ -)|g226>a,V76>I(+ - +)|' - fr1region_mutation_string: 'c16>g,Q6>E(+ + -)|' - fr2region_mutation_string: '' - fr3region_mutation_string: 'g226>a,V76>I(+ - +)|' - cdr1region_mutation_string: '' - cdr2region_mutation_string: '' - cdr3region_mutation_string: g319>a|a320>g| - vgene_probability: '99' - djregion_start: 307 - djregion_end: 374 - annotation_tool: VQuest + summary: + $ref: '#/definitions/ireceptor_sequence_summary_response' + items: + $ref: '#/definitions/ireceptor_sequence_response' '400': description: malformed request '401': @@ -1424,7 +883,8 @@ paths: description: data not found '405': description: method not allowed - /sequence_data: + /sequences_data: + x-swagger-router-controller: sequences get: description: > This service returns the annotation data that matches the GET provided @@ -1435,42 +895,17 @@ paths: tags: - sequences parameters: - - name: username - in: query - description: > - Username of the individual requesting access to the iReceptor - repository node. - required: true - type: string - - name: project_sample_id_list - in: query - required: true - type: array - items: - type: integer - - name: cdr3_length - in: query - description: >- - length of complementarity determining region in nucleotide base - pairs - required: false - type: integer - - name: vgene_string - in: query - required: false - type: string - - name: jgene_string - in: query - required: false - type: string - - name: format - in: query - description: >- - 'csv' - vQuest based CSV (as per /v1); 'tsv' - vQuest based TSV (as - per /v1 with tab delimiters instead of commas); 'airr' - AIRR - Formats rearrangements TSV (as per AIRR formats rearrangements spec) - required: false - type: string + - $ref: '#/parameters/ir_username' + - $ref: '#/parameters/ir_sample_id_list' + - $ref: '#/parameters/ir_data_format' + - $ref: '#/parameters/v_call' + - $ref: '#/parameters/d_call' + - $ref: '#/parameters/j_call' + - $ref: '#/parameters/junction_aa' + - $ref: '#/parameters/junction_length' + - $ref: '#/parameters/junction_aa_length' + - $ref: '#/parameters/functional' + - $ref: '#/parameters/ir_show_unproductive' operationId: getSequenceData responses: '200': @@ -1483,530 +918,7 @@ paths: comma-separated format; "tsv" returns a tab-delimited outputs; "airr" returns AIRR minimal standards encoded tab-delimited outputs. schema: - type: array - items: - type: object - properties: - seq_id: - type: integer - description: | - e.g. 1 - seq_name: - type: string - project_sample_id: - type: integer - description: | - e.g. 6 - id: - type: integer - description: | - e.g. 1 - sequence_id: - type: integer - description: | - e.g. 1 - vgene_string: - type: string - vgene_family: - type: string - description: | - e.g. IGHV4 - vgene_gene: - type: string - description: | - e.g. IGHV4-59 - vgene_allele: - type: string - description: | - e.g. IGHV4-59*01 or IGHV4-59*07 - dgene_string: - type: string - description: | - e.g. Homsap IGHD3-10*01 F - dgene_family: - type: string - description: | - e.g. IGHD3 - dgene_gene: - type: string - description: | - e.g. IGHD3-10 - dgene_allele: - type: string - description: | - e.g. IGHD3-10*01 - jgene_string: - type: string - description: | - e.g. Homsap IGHJ4*02 F - jgene_family: - type: string - description: | - e.g. IGHJ4 - jgene_gene: - type: string - description: | - e.g. IGHJ4 - jgene_allele: - type: string - description: | - e.g. IGHJ4*02 - functionality: - type: string - description: | - e.g. productive - functionality_comment: - type: string - description: | - e.g. "" - orientation: - type: string - description: | - e.g. + - vgene_score: - type: integer - description: | - e.g. 1127 - vgene_probability: - type: integer - description: | - e.g. 95 - dregion_reading_frame: - type: integer - description: | - e.g. 2 - cdr1_length: - type: integer - description: | - e.g. 8 - cdr2_length: - type: integer - description: | - e.g. 7 - cdr3_length: - type: integer - description: | - e.g. 13 - vdjregion_sequence_nt: - type: string - description: | - vdj region nucleotide sequence - vjregion_sequence_nt: - type: string - description: | - vj region nucleotide sequence - djregion_sequence_nt: - type: string - description: | - dj region nucleotide sequence - vregion_sequence_nt: - type: string - description: | - v region nucleotide sequence - dregion_sequence_nt: - type: string - description: | - d region nucleotide sequence - jregion_sequence_nt: - type: string - description: | - j region nucleotide sequence - fr1region_sequence_nt: - type: string - description: | - fr1 region nucleotide sequence - fr2region_sequence_nt: - type: string - description: | - fr2 region nucleotide sequence - fr3region_sequence_nt: - type: string - description: | - fr3 region nucleotide sequence - fr4region_sequence_nt: - type: string - description: | - fr4 region nucleotide sequence - cdr1region_sequence_nt: - type: string - description: | - cdr1 region nucleotide sequence - cdr2region_sequence_nt: - type: string - description: | - cdr2 region nucleotide sequence - cdr3region_sequence_nt: - type: string - description: | - cdr3 region nucleotide sequence - junction_sequence_nt: - type: string - description: | - junction nucleotide sequence - vdjregion_sequence_nt_gapped: - type: string - description: | - gapped vdj region nucleotide sequence - vjregion_sequence_nt_gapped: - type: string - description: | - gapped vj region nucleotide sequence - djregion_sequence_nt_gapped: - type: string - description: | - gapped dj region nucleotide sequence - vregion_sequence_nt_gapped: - type: string - description: | - gapped v region nucleotide sequence - dregion_sequence_nt_gapped: - type: string - description: | - gapped d region nucleotide sequence - jregion_sequence_nt_gapped: - type: string - description: | - gapped j region nucleotide sequence - fr1region_sequence_nt_gapped: - type: string - description: | - gapped fr1 region nucleotide sequence - fr2region_sequence_nt_gapped: - type: string - description: | - gapped fr2 region nucleotide sequence - fr3region_sequence_nt_gapped: - type: string - description: | - gapped fr3 region nucleotide sequence - fr4region_sequence_nt_gapped: - type: string - description: | - gapped fr4 region nucleotide sequence - cdr1region_sequence_nt_gapped: - type: string - description: | - gapped cdr1 region nucleotide sequence - cdr2region_sequence_nt_gapped: - type: string - description: | - gapped cdr2 region nucleotide sequence - cdr3region_sequence_nt_gapped: - type: string - description: | - gapped cdr3 region nucleotide sequence - junction_sequence_nt_gapped: - type: string - description: | - gapped junction nucleotide sequence - vdjregion_sequence_aa: - type: string - description: | - vdj region amino acid sequence - vjregion_sequence_aa: - type: string - description: | - vj region amino acid sequence - djregion_sequence_aa: - type: string - description: | - dj region amino acid sequence - vregion_sequence_aa: - type: string - description: | - v region amino acid sequence - dregion_sequence_aa: - type: string - description: | - d region amino acid sequence - jregion_sequence_aa: - type: string - description: | - j region amino acid sequence - fr1region_sequence_aa: - type: string - description: | - fr1 region amino acid sequence - fr2region_sequence_aa: - type: string - description: | - fr2 region amino acid sequence - fr3region_sequence_aa: - type: string - description: | - fr3 region amino acid sequence - fr4region_sequence_aa: - type: string - description: | - fr4 region amino acid sequence - cdr1region_sequence_aa: - type: string - description: | - cdr1 region amino acid sequence - cdr2region_sequence_aa: - type: string - description: | - cdr2 region amino acid sequence - cdr3region_sequence_aa: - type: string - description: | - cdr3 region amino acid sequence - junction_sequence_aa: - type: string - description: | - junction amino acid sequence - vdjregion_sequence_aa_gapped: - type: string - description: | - gapped vdj region amino acid sequence - vjregion_sequence_aa_gapped: - type: string - description: | - gapped vj region amino acid sequence - djregion_sequence_aa_gapped: - type: string - description: | - gapped dj region amino acid sequence - vregion_sequence_aa_gapped: - type: string - description: | - gapped v region amino acid sequence - dregion_sequence_aa_gapped: - type: string - description: | - gapped d region amino acid sequence - jregion_sequence_aa_gapped: - type: string - description: | - gapped j region amino acid sequence - fr1region_sequence_aa_gapped: - type: string - description: | - gapped fr1 region amino acid sequence - fr2region_sequence_aa_gapped: - type: string - description: | - gapped fr2 region amino acid sequence - fr3region_sequence_aa_gapped: - type: string - description: | - gapped fr3 region amino acid sequence - fr4region_sequence_aa_gapped: - type: string - description: | - gapped fr4 region amino acid sequence - cdr1region_sequence_aa_gapped: - type: string - description: | - gapped cdr1 region amino acid sequence - cdr2region_sequence_aa_gapped: - type: string - description: | - gapped cdr2 region amino acid sequence - cdr3region_sequence_aa_gapped: - type: string - description: | - gapped cdr3 region amino acid sequence - junction_sequence_aa_gapped: - type: string - description: | - gapped junction amino acid sequence - vdjregion_start: - type: integer - description: | - e.g. 1 - vdjregion_end: - type: integer - description: | - e.g. 321 - vjregion_start: - type: integer - description: | - e.g. 0 - vjregion_end: - type: integer - description: | - e.g. 0 - djregion_start: - type: integer - description: | - e.g. 254 - djregion_end: - type: integer - description: | - e.g. 321 - vregion_start: - type: integer - description: | - e.g. 286 - vregion_end: - type: integer - description: | - e.g. 252 - dregion_start: - type: integer - description: | - e.g. 254 - dregion_end: - type: integer - description: | - e.g. 321 - jregion_start: - type: integer - description: | - e.g. 286 - jregion_end: - type: integer - description: | - e.g. 321 - fr1region_start: - type: integer - description: | - e.g. 1 - fr1region_end: - type: integer - description: | - e.g. 38 - fr2region_start: - type: integer - description: | - e.g. 63 - fr2region_end: - type: integer - description: | - e.g. 113 - fr3region_start: - type: integer - description: | - e.g. 135 - fr3region_end: - type: integer - description: | - e.g. 248 - fr4region_start: - type: integer - description: | - e.g. 288 - fr4region_end: - type: integer - description: | - e.g. 321 - cdr1region_start: - type: integer - description: | - e.g. 39 - cdr1region_end: - type: integer - description: | - e.g. 321 - cdr2region_start: - type: integer - description: | - e.g. 62 - cdr2region_end: - type: integer - description: | - e.g. 134 - cdr3region_start: - type: integer - description: | - e.g. 249 - cdr3region_end: - type: integer - description: | - e.g. 287 - junction_start: - type: integer - description: | - e.g. 246 - junction_end: - type: integer - description: | - e.g. 290 - vregion_mutation_string: - type: string - description: > - e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - - +)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- - - -)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ + - -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c| - fr1region_mutation_string: - type: string - description: | - e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)| - fr2region_mutation_string: - type: string - description: | - e.g. - fr3region_mutation_string: - type: string - description: > - e.g. c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+ - - +)|g275>c,S92>T(+ - +)|t279>c|" - cdr1region_mutation_string: - type: string - description: | - e.g. - cdr2region_mutation_string: - type: string - description: | - e.g. a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|" - cdr3region_mutation_string: - type: string - description: | - e.g. g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t - citation: - type: object - properties: - doi: - type: string - title: - type: string - examples: - application/json: - seq_name: | - M00930:18:000000000-A3782:1:1101:11543:3128_1:N:0 - vgene_gene: | - IGHV4-59 - vgene_allele: | - IGHV4-59*01 or IGHV4-59*07 - dgene_string: | - Homsap IGHD3-10*01 F - dgene_family: | - IGHD3 - dgene_gene: | - IGHD3-10 - dgene_allele: | - IGHD3-10*01 - jgene_string: | - Homsap IGHJ4*02 F - jgene_family: | - IGHJ4 - jgene_gene: | - IGHJ4 - jgene_allele: | - IGHJ4*02 - functionality: | - productive - vregion_mutation_string: | - a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - - +)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- - - -)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ + - -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c| - fr1region_mutation_string: | - e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)| - fr3region_mutation_string: | - c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+ - - +)|g275>c,S92>T(+ - +)|t279>c|" - cdr2region_mutation_string: | - a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|" - cdr3region_mutation_string: | - g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t - citation: - doi: 10.1093/cid/ciw767 - title: > - RNA-Seq Analysis of Gene Expression, Viral Pathogen, and - B-Cell/T-Cell Receptor Signatures in Complex Chronic Disease. + $ref: '#/definitions/ireceptor_sequence_response' '400': description: malformed request '401': @@ -2028,37 +940,17 @@ paths: tags: - sequences parameters: - - name: query - in: body - schema: - type: object - required: - - username - properties: - username: - type: string - description: > - Username of the individual requesting access to the iReceptor - repository node. - project_sample_id_list: - type: array - items: - type: integer - cdr3_length: - description: > - length of complementarity determining region in nucleotide - base pairs - type: integer - vgene_string: - type: string - jgene_string: - type: string - format: - description: >- - 'csv' - vQuest based CSV (as per /v1); 'tsv' - vQuest based - TSV (as per /v1 with tab delimiters instead of commas); 'airr' - - AIRR Formats rearrangements TSV (as per AIRR formats - rearrangements spec) + - $ref: '#/parameters/ir_username_form' + - $ref: '#/parameters/ir_sample_id_list_form' + - $ref: '#/parameters/ir_data_format_form' + - $ref: '#/parameters/v_call_form' + - $ref: '#/parameters/d_call_form' + - $ref: '#/parameters/j_call_form' + - $ref: '#/parameters/junction_aa_form' + - $ref: '#/parameters/junction_length_form' + - $ref: '#/parameters/junction_aa_length_form' + - $ref: '#/parameters/functional_form' + - $ref: '#/parameters/ir_show_unproductive_form' operationId: postSequenceData responses: '200': @@ -2071,488 +963,7 @@ paths: comma-separated format; "tsv" returns a tab-delimited outputs; "airr" returns AIRR minimal standards encoded tab-delimited outputs. schema: - type: array - items: - type: object - properties: - seq_id: - type: integer - description: | - e.g. 1 - seq_name: - type: string - project_sample_id: - type: integer - description: | - e.g. 6 - id: - type: integer - description: | - e.g. 1 - sequence_id: - type: integer - description: | - e.g. 1 - vgene_string: - type: string - vgene_family: - type: string - vgene_gene: - type: string - vgene_allele: - type: string - dgene_string: - type: string - dgene_family: - type: string - dgene_gene: - type: string - dgene_allele: - type: string - jgene_string: - type: string - jgene_family: - type: string - jgene_gene: - type: string - jgene_allele: - type: string - functionality: - type: string - functionality_comment: - type: string - description: | - e.g. "" - orientation: - type: string - description: | - e.g. + - vgene_score: - type: integer - description: | - e.g. 1127 - vgene_probability: - type: integer - description: | - e.g. 95 - dregion_reading_frame: - type: integer - description: | - e.g. 2 - cdr1_length: - type: integer - description: | - e.g. 8 - cdr2_length: - type: integer - description: | - e.g. 7 - cdr3_length: - type: integer - description: | - e.g. 13 - vdjregion_sequence_nt: - type: string - description: | - vdj region nucleotide sequence - vjregion_sequence_nt: - type: string - description: | - vj region nucleotide sequence - djregion_sequence_nt: - type: string - description: | - dj region nucleotide sequence - vregion_sequence_nt: - type: string - description: | - v region nucleotide sequence - dregion_sequence_nt: - type: string - description: | - d region nucleotide sequence - jregion_sequence_nt: - type: string - description: | - j region nucleotide sequence - fr1region_sequence_nt: - type: string - description: | - fr1 region nucleotide sequence - fr2region_sequence_nt: - type: string - description: | - fr2 region nucleotide sequence - fr3region_sequence_nt: - type: string - description: | - fr3 region nucleotide sequence - fr4region_sequence_nt: - type: string - description: | - fr4 region nucleotide sequence - cdr1region_sequence_nt: - type: string - description: | - cdr1 region nucleotide sequence - cdr2region_sequence_nt: - type: string - description: | - cdr2 region nucleotide sequence - cdr3region_sequence_nt: - type: string - description: | - cdr3 region nucleotide sequence - junction_sequence_nt: - type: string - description: | - junction nucleotide sequence - vdjregion_sequence_nt_gapped: - type: string - description: | - gapped vdj region nucleotide sequence - vjregion_sequence_nt_gapped: - type: string - description: | - gapped vj region nucleotide sequence - djregion_sequence_nt_gapped: - type: string - description: | - gapped dj region nucleotide sequence - vregion_sequence_nt_gapped: - type: string - description: | - gapped v region nucleotide sequence - dregion_sequence_nt_gapped: - type: string - description: | - gapped d region nucleotide sequence - jregion_sequence_nt_gapped: - type: string - description: | - gapped j region nucleotide sequence - fr1region_sequence_nt_gapped: - type: string - description: | - gapped fr1 region nucleotide sequence - fr2region_sequence_nt_gapped: - type: string - description: | - gapped fr2 region nucleotide sequence - fr3region_sequence_nt_gapped: - type: string - description: | - gapped fr3 region nucleotide sequence - fr4region_sequence_nt_gapped: - type: string - description: | - gapped fr4 region nucleotide sequence - cdr1region_sequence_nt_gapped: - type: string - description: | - gapped cdr1 region nucleotide sequence - cdr2region_sequence_nt_gapped: - type: string - description: | - gapped cdr2 region nucleotide sequence - cdr3region_sequence_nt_gapped: - type: string - description: | - gapped cdr3 region nucleotide sequence - junction_sequence_nt_gapped: - type: string - description: | - gapped junction nucleotide sequence - vdjregion_sequence_aa: - type: string - description: | - vdj region amino acid sequence - vjregion_sequence_aa: - type: string - description: | - vj region amino acid sequence - djregion_sequence_aa: - type: string - description: | - dj region amino acid sequence - vregion_sequence_aa: - type: string - description: | - v region amino acid sequence - dregion_sequence_aa: - type: string - description: | - d region amino acid sequence - jregion_sequence_aa: - type: string - description: | - j region amino acid sequence - fr1region_sequence_aa: - type: string - description: | - fr1 region amino acid sequence - fr2region_sequence_aa: - type: string - description: | - fr2 region amino acid sequence - fr3region_sequence_aa: - type: string - description: | - fr3 region amino acid sequence - fr4region_sequence_aa: - type: string - description: | - fr4 region amino acid sequence - cdr1region_sequence_aa: - type: string - description: | - cdr1 region amino acid sequence - cdr2region_sequence_aa: - type: string - description: | - cdr2 region amino acid sequence - cdr3region_sequence_aa: - type: string - description: | - cdr3 region amino acid sequence - junction_sequence_aa: - type: string - description: | - junction amino acid sequence - vdjregion_sequence_aa_gapped: - type: string - description: | - gapped vdj region amino acid sequence - vjregion_sequence_aa_gapped: - type: string - description: | - gapped vj region amino acid sequence - djregion_sequence_aa_gapped: - type: string - description: | - gapped dj region amino acid sequence - vregion_sequence_aa_gapped: - type: string - description: | - gapped v region amino acid sequence - dregion_sequence_aa_gapped: - type: string - description: | - gapped d region amino acid sequence - jregion_sequence_aa_gapped: - type: string - description: | - gapped j region amino acid sequence - fr1region_sequence_aa_gapped: - type: string - description: | - gapped fr1 region amino acid sequence - fr2region_sequence_aa_gapped: - type: string - description: | - gapped fr2 region amino acid sequence - fr3region_sequence_aa_gapped: - type: string - description: | - gapped fr3 region amino acid sequence - fr4region_sequence_aa_gapped: - type: string - description: | - gapped fr4 region amino acid sequence - cdr1region_sequence_aa_gapped: - type: string - description: | - gapped cdr1 region amino acid sequence - cdr2region_sequence_aa_gapped: - type: string - description: | - gapped cdr2 region amino acid sequence - cdr3region_sequence_aa_gapped: - type: string - description: | - gapped cdr3 region amino acid sequence - junction_sequence_aa_gapped: - type: string - description: | - gapped junction amino acid sequence - vdjregion_start: - type: integer - description: | - e.g. 1 - vdjregion_end: - type: integer - description: | - e.g. 321 - vjregion_start: - type: integer - description: | - e.g. 0 - vjregion_end: - type: integer - description: | - e.g. 0 - djregion_start: - type: integer - description: | - e.g. 254 - djregion_end: - type: integer - description: | - e.g. 321 - vregion_start: - type: integer - description: | - e.g. 286 - vregion_end: - type: integer - description: | - e.g. 252 - dregion_start: - type: integer - description: | - e.g. 254 - dregion_end: - type: integer - description: | - e.g. 321 - jregion_start: - type: integer - description: | - e.g. 286 - jregion_end: - type: integer - description: | - e.g. 321 - fr1region_start: - type: integer - description: | - e.g. 1 - fr1region_end: - type: integer - description: | - e.g. 38 - fr2region_start: - type: integer - description: | - e.g. 63 - fr2region_end: - type: integer - description: | - e.g. 113 - fr3region_start: - type: integer - description: | - e.g. 135 - fr3region_end: - type: integer - description: | - e.g. 248 - fr4region_start: - type: integer - description: | - e.g. 288 - fr4region_end: - type: integer - description: | - e.g. 321 - cdr1region_start: - type: integer - description: | - e.g. 39 - cdr1region_end: - type: integer - description: | - e.g. 321 - cdr2region_start: - type: integer - description: | - e.g. 62 - cdr2region_end: - type: integer - description: | - e.g. 134 - cdr3region_start: - type: integer - description: | - e.g. 249 - cdr3region_end: - type: integer - description: | - e.g. 287 - junction_start: - type: integer - description: | - e.g. 246 - junction_end: - type: integer - description: | - e.g. 290 - vregion_mutation_string: - type: string - fr1region_mutation_string: - type: string - fr2region_mutation_string: - type: string - fr3region_mutation_string: - type: string - cdr1region_mutation_string: - type: string - cdr2region_mutation_string: - type: string - cdr3region_mutation_string: - type: string - citation: - type: object - properties: - doi: - type: string - title: - type: string - examples: - application/json: - seq_name: | - M00930:18:000000000-A3782:1:1101:11543:3128_1:N:0 - vgene_gene: | - IGHV4-59 - vgene_allele: | - IGHV4-59*01 or IGHV4-59*07 - dgene_string: | - Homsap IGHD3-10*01 F - dgene_family: | - IGHD3 - dgene_gene: | - IGHD3-10 - dgene_allele: | - IGHD3-10*01 - jgene_string: | - Homsap IGHJ4*02 F - jgene_family: | - IGHJ4 - jgene_gene: | - IGHJ4 - jgene_allele: | - IGHJ4*02 - functionality: | - productive - vregion_mutation_string: | - a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - - +)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- - - -)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ + - -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c| - fr1region_mutation_string: | - e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)| - fr3region_mutation_string: | - c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+ - - +)|g275>c,S92>T(+ - +)|t279>c|" - cdr2region_mutation_string: | - a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|" - cdr3region_mutation_string: | - g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t - citation: - doi: 10.1093/cid/ciw767 - title: > - RNA-Seq Analysis of Gene Expression, Viral Pathogen, and - B-Cell/T-Cell Receptor Signatures in Complex Chronic Disease. + $ref: '#/definitions/ireceptor_sequence_response' '400': description: malformed request '401': @@ -2564,42 +975,25 @@ paths: '405': description: method not allowed /clones_summary: - get: + x-swagger-router-controller: clones + post: description: > This service returns a summary of sequence clones that match the GET provided filter. "username" parameter refers to external_users table. tags: - clones parameters: - - name: username - in: query - description: > - Username of the individual requesting access to the iReceptor - repository node. - required: true - type: string - - name: project_sample_id_list - in: query - required: true - type: array - items: - type: integer - - name: cdr3_length - in: query - description: >- - length of complementarity determining region in nucleotide base - pairs - required: false - type: integer - - name: vgene_string - in: query - required: false - type: string - - name: jgene_string - in: query - required: false - type: string - operationId: getCloneSummary + - $ref: '#/parameters/ir_username_form' + - $ref: '#/parameters/ir_sample_id_list_form' + - $ref: '#/parameters/v_call_form' + - $ref: '#/parameters/d_call_form' + - $ref: '#/parameters/j_call_form' + - $ref: '#/parameters/junction_aa_form' + - $ref: '#/parameters/junction_length_form' + - $ref: '#/parameters/junction_aa_length_form' + - $ref: '#/parameters/functional_form' + - $ref: '#/parameters/ir_show_unproductive_form' + operationId: postCloneSummary responses: '200': description: > @@ -2607,18 +1001,12 @@ paths: 'category' = count pairs in which the 'category' are string tags of parameters of interest from a controlled vocabulary term set. schema: - type: array - items: - type: object - properties: - category: - type: string - description: | - e.g. samples - count: - type: integer - description: | - e.g. 100 + type: object + properties: + summary: + $ref: '#/definitions/ireceptor_sequence_summary_response' + items: + $ref: '#/definitions/ireceptor_sequence_response' '400': description: malformed request '401': @@ -2630,42 +1018,26 @@ paths: '405': description: method not allowed /clones_data: - get: + x-swagger-router-controller: clones + post: description: > This service returns a list of clones that matches the GET provided filter. "username" parameter refers to external_users table. tags: - clones parameters: - - name: username - in: query - description: > - Username of the individual requesting access to the iReceptor - repository node. - required: true - type: string - - name: project_sample_id_list - in: query - required: true - type: array - items: - type: integer - - name: cdr3_length - in: query - description: >- - length of complementarity determining region in nucleotide base - pairs - required: false - type: integer - - name: vgene_string - in: query - required: false - type: string - - name: jgene_string - in: query - required: false - type: string - operationId: getCloneData + - $ref: '#/parameters/ir_username_form' + - $ref: '#/parameters/ir_sample_id_list_form' + - $ref: '#/parameters/ir_data_format_form' + - $ref: '#/parameters/v_call_form' + - $ref: '#/parameters/d_call_form' + - $ref: '#/parameters/j_call_form' + - $ref: '#/parameters/junction_aa_form' + - $ref: '#/parameters/junction_length_form' + - $ref: '#/parameters/junction_aa_length_form' + - $ref: '#/parameters/functional_form' + - $ref: '#/parameters/ir_show_unproductive_form' + operationId: postCloneData responses: '200': description: > @@ -2676,530 +1048,7 @@ paths: sample information and annotation tool information, in a comma-separated format. schema: - type: array - items: - type: object - properties: - seq_id: - type: integer - description: | - e.g. 1 - seq_name: - type: string - project_sample_id: - type: integer - description: | - e.g. 6 - id: - type: integer - description: | - e.g. 1 - sequence_id: - type: integer - description: | - e.g. 1 - vgene_string: - type: string - vgene_family: - type: string - description: | - e.g. IGHV4 - vgene_gene: - type: string - description: | - e.g. IGHV4-59 - vgene_allele: - type: string - description: | - e.g. IGHV4-59*01 or IGHV4-59*07 - dgene_string: - type: string - description: | - e.g. Homsap IGHD3-10*01 F - dgene_family: - type: string - description: | - e.g. IGHD3 - dgene_gene: - type: string - description: | - e.g. IGHD3-10 - dgene_allele: - type: string - description: | - e.g. IGHD3-10*01 - jgene_string: - type: string - description: | - e.g. Homsap IGHJ4*02 F - jgene_family: - type: string - description: | - e.g. IGHJ4 - jgene_gene: - type: string - description: | - e.g. IGHJ4 - jgene_allele: - type: string - description: | - e.g. IGHJ4*02 - functionality: - type: string - description: | - e.g. productive - functionality_comment: - type: string - description: | - e.g. "" - orientation: - type: string - description: | - e.g. + - vgene_score: - type: integer - description: | - e.g. 1127 - vgene_probability: - type: integer - description: | - e.g. 95 - dregion_reading_frame: - type: integer - description: | - e.g. 2 - cdr1_length: - type: integer - description: | - e.g. 8 - cdr2_length: - type: integer - description: | - e.g. 7 - cdr3_length: - type: integer - description: | - e.g. 13 - vdjregion_sequence_nt: - type: string - description: | - vdj region nucleotide sequence - vjregion_sequence_nt: - type: string - description: | - vj region nucleotide sequence - djregion_sequence_nt: - type: string - description: | - dj region nucleotide sequence - vregion_sequence_nt: - type: string - description: | - v region nucleotide sequence - dregion_sequence_nt: - type: string - description: | - d region nucleotide sequence - jregion_sequence_nt: - type: string - description: | - j region nucleotide sequence - fr1region_sequence_nt: - type: string - description: | - fr1 region nucleotide sequence - fr2region_sequence_nt: - type: string - description: | - fr2 region nucleotide sequence - fr3region_sequence_nt: - type: string - description: | - fr3 region nucleotide sequence - fr4region_sequence_nt: - type: string - description: | - fr4 region nucleotide sequence - cdr1region_sequence_nt: - type: string - description: | - cdr1 region nucleotide sequence - cdr2region_sequence_nt: - type: string - description: | - cdr2 region nucleotide sequence - cdr3region_sequence_nt: - type: string - description: | - cdr3 region nucleotide sequence - junction_sequence_nt: - type: string - description: | - junction nucleotide sequence - vdjregion_sequence_nt_gapped: - type: string - description: | - gapped vdj region nucleotide sequence - vjregion_sequence_nt_gapped: - type: string - description: | - gapped vj region nucleotide sequence - djregion_sequence_nt_gapped: - type: string - description: | - gapped dj region nucleotide sequence - vregion_sequence_nt_gapped: - type: string - description: | - gapped v region nucleotide sequence - dregion_sequence_nt_gapped: - type: string - description: | - gapped d region nucleotide sequence - jregion_sequence_nt_gapped: - type: string - description: | - gapped j region nucleotide sequence - fr1region_sequence_nt_gapped: - type: string - description: | - gapped fr1 region nucleotide sequence - fr2region_sequence_nt_gapped: - type: string - description: | - gapped fr2 region nucleotide sequence - fr3region_sequence_nt_gapped: - type: string - description: | - gapped fr3 region nucleotide sequence - fr4region_sequence_nt_gapped: - type: string - description: | - gapped fr4 region nucleotide sequence - cdr1region_sequence_nt_gapped: - type: string - description: | - gapped cdr1 region nucleotide sequence - cdr2region_sequence_nt_gapped: - type: string - description: | - gapped cdr2 region nucleotide sequence - cdr3region_sequence_nt_gapped: - type: string - description: | - gapped cdr3 region nucleotide sequence - junction_sequence_nt_gapped: - type: string - description: | - gapped junction nucleotide sequence - vdjregion_sequence_aa: - type: string - description: | - vdj region amino acid sequence - vjregion_sequence_aa: - type: string - description: | - vj region amino acid sequence - djregion_sequence_aa: - type: string - description: | - dj region amino acid sequence - vregion_sequence_aa: - type: string - description: | - v region amino acid sequence - dregion_sequence_aa: - type: string - description: | - d region amino acid sequence - jregion_sequence_aa: - type: string - description: | - j region amino acid sequence - fr1region_sequence_aa: - type: string - description: | - fr1 region amino acid sequence - fr2region_sequence_aa: - type: string - description: | - fr2 region amino acid sequence - fr3region_sequence_aa: - type: string - description: | - fr3 region amino acid sequence - fr4region_sequence_aa: - type: string - description: | - fr4 region amino acid sequence - cdr1region_sequence_aa: - type: string - description: | - cdr1 region amino acid sequence - cdr2region_sequence_aa: - type: string - description: | - cdr2 region amino acid sequence - cdr3region_sequence_aa: - type: string - description: | - cdr3 region amino acid sequence - junction_sequence_aa: - type: string - description: | - junction amino acid sequence - vdjregion_sequence_aa_gapped: - type: string - description: | - gapped vdj region amino acid sequence - vjregion_sequence_aa_gapped: - type: string - description: | - gapped vj region amino acid sequence - djregion_sequence_aa_gapped: - type: string - description: | - gapped dj region amino acid sequence - vregion_sequence_aa_gapped: - type: string - description: | - gapped v region amino acid sequence - dregion_sequence_aa_gapped: - type: string - description: | - gapped d region amino acid sequence - jregion_sequence_aa_gapped: - type: string - description: | - gapped j region amino acid sequence - fr1region_sequence_aa_gapped: - type: string - description: | - gapped fr1 region amino acid sequence - fr2region_sequence_aa_gapped: - type: string - description: | - gapped fr2 region amino acid sequence - fr3region_sequence_aa_gapped: - type: string - description: | - gapped fr3 region amino acid sequence - fr4region_sequence_aa_gapped: - type: string - description: | - gapped fr4 region amino acid sequence - cdr1region_sequence_aa_gapped: - type: string - description: | - gapped cdr1 region amino acid sequence - cdr2region_sequence_aa_gapped: - type: string - description: | - gapped cdr2 region amino acid sequence - cdr3region_sequence_aa_gapped: - type: string - description: | - gapped cdr3 region amino acid sequence - junction_sequence_aa_gapped: - type: string - description: | - gapped junction amino acid sequence - vdjregion_start: - type: integer - description: | - e.g. 1 - vdjregion_end: - type: integer - description: | - e.g. 321 - vjregion_start: - type: integer - description: | - e.g. 0 - vjregion_end: - type: integer - description: | - e.g. 0 - djregion_start: - type: integer - description: | - e.g. 254 - djregion_end: - type: integer - description: | - e.g. 321 - vregion_start: - type: integer - description: | - e.g. 286 - vregion_end: - type: integer - description: | - e.g. 252 - dregion_start: - type: integer - description: | - e.g. 254 - dregion_end: - type: integer - description: | - e.g. 321 - jregion_start: - type: integer - description: | - e.g. 286 - jregion_end: - type: integer - description: | - e.g. 321 - fr1region_start: - type: integer - description: | - e.g. 1 - fr1region_end: - type: integer - description: | - e.g. 38 - fr2region_start: - type: integer - description: | - e.g. 63 - fr2region_end: - type: integer - description: | - e.g. 113 - fr3region_start: - type: integer - description: | - e.g. 135 - fr3region_end: - type: integer - description: | - e.g. 248 - fr4region_start: - type: integer - description: | - e.g. 288 - fr4region_end: - type: integer - description: | - e.g. 321 - cdr1region_start: - type: integer - description: | - e.g. 39 - cdr1region_end: - type: integer - description: | - e.g. 321 - cdr2region_start: - type: integer - description: | - e.g. 62 - cdr2region_end: - type: integer - description: | - e.g. 134 - cdr3region_start: - type: integer - description: | - e.g. 249 - cdr3region_end: - type: integer - description: | - e.g. 287 - junction_start: - type: integer - description: | - e.g. 246 - junction_end: - type: integer - description: | - e.g. 290 - vregion_mutation_string: - type: string - description: > - e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - - +)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- - - -)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ + - -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c| - fr1region_mutation_string: - type: string - description: | - e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)| - fr2region_mutation_string: - type: string - description: | - e.g. - fr3region_mutation_string: - type: string - description: > - e.g. c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+ - - +)|g275>c,S92>T(+ - +)|t279>c|" - cdr1region_mutation_string: - type: string - description: | - e.g. - cdr2region_mutation_string: - type: string - description: | - e.g. a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|" - cdr3region_mutation_string: - type: string - description: | - e.g. g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t - citation: - type: object - properties: - doi: - type: string - title: - type: string - examples: - application/json: - seq_name: | - M00930:18:000000000-A3782:1:1101:11543:3128_1:N:0 - vgene_gene: | - IGHV4-59 - vgene_allele: | - IGHV4-59*01 or IGHV4-59*07 - dgene_string: | - Homsap IGHD3-10*01 F - dgene_family: | - IGHD3 - dgene_gene: | - IGHD3-10 - dgene_allele: | - IGHD3-10*01 - jgene_string: | - Homsap IGHJ4*02 F - jgene_family: | - IGHJ4 - jgene_gene: | - IGHJ4 - jgene_allele: | - IGHJ4*02 - functionality: | - productive - vregion_mutation_string: | - a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - - +)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- - - -)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ + - -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c| - fr1region_mutation_string: | - e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)| - fr3region_mutation_string: | - c198>g,N66>K(+ - -)|a220>g,S74>G(+ + -)|a229>t,T77>S(+ - - +)|g275>c,S92>T(+ - +)|t279>c|" - cdr2region_mutation_string: | - a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|" - cdr3region_mutation_string: | - g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t - citation: - doi: 10.1093/cid/ciw767 - title: > - RNA-Seq Analysis of Gene Expression, Viral Pathogen, and - B-Cell/T-Cell Receptor Signatures in Complex Chronic Disease. + $ref: '#/definitions/ireceptor_sequence_response' '400': description: malformed request '401': diff --git a/ireceptor_sequence.yaml b/ireceptor_sequence.yaml new file mode 100644 index 0000000..8001bda --- /dev/null +++ b/ireceptor_sequence.yaml @@ -0,0 +1,464 @@ +# This model defines ancillary information returned by iReceptor +# as part of the sequence API. + + ireceptor_sequence_annotation_model: + type: object + properties: + junction_aa_length: + type: integer + description: >- + Length of JUNCTION in amino acids + ir_seq_id: + type: integer + description: | + e.g. 1 + ir_seq_name: + type: string + ir_project_sample_id: + type: integer + description: | + e.g. 6 + ir_id: + type: integer + description: | + e.g. 1 + ir_sequence_id: + type: integer + description: | + e.g. 1 + ir_vgene_string: + type: string + description: | + e.g IGHV4-59*01 or IGHV4-59*07 + ir_vgene_family: + type: string + description: | + e.g. IGHV4 + ir_vgene_gene: + type: string + description: | + e.g. IGHV4-59 + ir_dgene_string: + type: string + description: | + e.g. Homsap IGHD3-10*01 F + ir_dgene_family: + type: string + description: | + e.g. IGHD3 + ir_dgene_gene: + type: string + description: | + e.g. IGHD3-10 + ir_jgene_string: + type: string + description: | + e.g. Homsap IGHJ4*02 F + ir_jgene_family: + type: string + description: | + e.g. IGHJ4 + ir_jgene_gene: + type: string + description: | + e.g. IGHJ4 + ir_functionality: + type: string + description: | + e.g. productive + ir_functionality_comment: + type: string + description: | + e.g. "" + ir_orientation: + type: string + description: | + e.g. + + ir_vgene_score: + type: integer + description: | + e.g. 1127 + ir_vgene_probability: + type: integer + description: | + e.g. 95 + ir_dregion_reading_frame: + type: integer + description: | + e.g. 2 + ir_cdr1_length: + type: integer + description: | + e.g. 8 + ir_cdr2_length: + type: integer + description: | + e.g. 7 + ir_cdr3_length: + type: integer + description: | + e.g. 13 + ir_vdjregion_sequence_nt: + type: string + description: | + vdj region nucleotide sequence + ir_vjregion_sequence_nt: + type: string + description: | + vj region nucleotide sequence + ir_djregion_sequence_nt: + type: string + description: | + dj region nucleotide sequence + ir_vregion_sequence_nt: + type: string + description: | + v region nucleotide sequence + ir_dregion_sequence_nt: + type: string + description: | + d region nucleotide sequence + ir_jregion_sequence_nt: + type: string + description: | + j region nucleotide sequence + ir_fr1region_sequence_nt: + type: string + description: | + fr1 region nucleotide sequence + ir_fr2region_sequence_nt: + type: string + description: | + fr2 region nucleotide sequence + ir_fr3region_sequence_nt: + type: string + description: | + fr3 region nucleotide sequence + ir_fr4region_sequence_nt: + type: string + description: | + fr4 region nucleotide sequence + ir_cdr1region_sequence_nt: + type: string + description: | + cdr1 region nucleotide sequence + ir_cdr2region_sequence_nt: + type: string + description: | + cdr2 region nucleotide sequence + ir_cdr3region_sequence_nt: + type: string + description: | + cdr3 region nucleotide sequence + ir_vdjregion_sequence_nt_gapped: + type: string + description: | + gapped vdj region nucleotide sequence + ir_vjregion_sequence_nt_gapped: + type: string + description: | + gapped vj region nucleotide sequence + ir_djregion_sequence_nt_gapped: + type: string + description: | + gapped dj region nucleotide sequence + ir_vregion_sequence_nt_gapped: + type: string + description: | + gapped v region nucleotide sequence + ir_dregion_sequence_nt_gapped: + type: string + description: | + gapped d region nucleotide sequence + ir_jregion_sequence_nt_gapped: + type: string + description: | + gapped j region nucleotide sequence + ir_fr1region_sequence_nt_gapped: + type: string + description: | + gapped fr1 region nucleotide sequence + ir_fr2region_sequence_nt_gapped: + type: string + description: | + gapped fr2 region nucleotide sequence + ir_fr3region_sequence_nt_gapped: + type: string + description: | + gapped fr3 region nucleotide sequence + ir_fr4region_sequence_nt_gapped: + type: string + description: | + gapped fr4 region nucleotide sequence + ir_cdr1region_sequence_nt_gapped: + type: string + description: | + gapped cdr1 region nucleotide sequence + ir_cdr2region_sequence_nt_gapped: + type: string + description: | + gapped cdr2 region nucleotide sequence + ir_cdr3region_sequence_nt_gapped: + type: string + description: | + gapped cdr3 region nucleotide sequence + ir_junction_sequence_nt_gapped: + type: string + description: | + gapped junction nucleotide sequence + ir_vdjregion_sequence_aa: + type: string + description: | + vdj region amino acid sequence + ir_vjregion_sequence_aa: + type: string + description: | + vj region amino acid sequence + ir_djregion_sequence_aa: + type: string + description: | + dj region amino acid sequence + ir_vregion_sequence_aa: + type: string + description: | + v region amino acid sequence + ir_dregion_sequence_aa: + type: string + description: | + d region amino acid sequence + ir_jregion_sequence_aa: + type: string + description: | + j region amino acid sequence + ir_fr1region_sequence_aa: + type: string + description: | + fr1 region amino acid sequence + ir_fr2region_sequence_aa: + type: string + description: | + fr2 region amino acid sequence + ir_fr3region_sequence_aa: + type: string + description: | + fr3 region amino acid sequence + ir_fr4region_sequence_aa: + type: string + description: | + fr4 region amino acid sequence + ir_cdr1region_sequence_aa: + type: string + description: | + cdr1 region amino acid sequence + ir_cdr2region_sequence_aa: + type: string + description: | + cdr2 region amino acid sequence + ir_cdr3region_sequence_aa: + type: string + description: | + cdr3 region amino acid sequence + ir_vdjregion_sequence_aa_gapped: + type: string + description: | + gapped vdj region amino acid sequence + ir_vjregion_sequence_aa_gapped: + type: string + description: | + gapped vj region amino acid sequence + ir_djregion_sequence_aa_gapped: + type: string + description: | + gapped dj region amino acid sequence + ir_vregion_sequence_aa_gapped: + type: string + description: | + gapped v region amino acid sequence + ir_dregion_sequence_aa_gapped: + type: string + description: | + gapped d region amino acid sequence + ir_jregion_sequence_aa_gapped: + type: string + description: | + gapped j region amino acid sequence + ir_fr1region_sequence_aa_gapped: + type: string + description: | + gapped fr1 region amino acid sequence + ir_fr2region_sequence_aa_gapped: + type: string + description: | + gapped fr2 region amino acid sequence + fr3region_sequence_aa_gapped: + type: string + description: | + gapped fr3 region amino acid sequence + ir_fr4region_sequence_aa_gapped: + type: string + description: | + gapped fr4 region amino acid sequence + ir_cdr1region_sequence_aa_gapped: + type: string + description: | + gapped cdr1 region amino acid sequence + ir_cdr2region_sequence_aa_gapped: + type: string + description: | + gapped cdr2 region amino acid sequence + cdr3region_sequence_aa_gapped: + type: string + description: | + gapped cdr3 region amino acid sequence + ir_junction_sequence_aa_gapped: + type: string + description: | + gapped junction amino acid sequence + ir_vdjregion_start: + type: integer + description: | + e.g. 1 + ir_vdjregion_end: + type: integer + description: | + e.g. 321 + ir_vjregion_start: + type: integer + description: | + e.g. 0 + ir_vjregion_end: + type: integer + description: | + e.g. 0 + ir_djregion_start: + type: integer + description: | + e.g. 254 + ir_djregion_end: + type: integer + description: | + e.g. 321 + ir_vregion_start: + type: integer + description: | + e.g. 286 + ir_vregion_end: + type: integer + description: | + e.g. 252 + ir_dregion_start: + type: integer + description: | + e.g. 254 + ir_dregion_end: + type: integer + description: | + e.g. 321 + ir_jregion_start: + type: integer + description: | + e.g. 286 + ir_jregion_end: + type: integer + description: | + e.g. 321 + ir_fr1region_start: + type: integer + description: | + e.g. 1 + fr1region_end: + type: integer + description: | + e.g. 38 + ir_fr2region_start: + type: integer + description: | + e.g. 63 + ir_fr2region_end: + type: integer + description: | + e.g. 113 + ir_fr3region_start: + type: integer + description: | + e.g. 135 + ir_fr3region_end: + type: integer + description: | + e.g. 248 + ir_fr4region_start: + type: integer + description: | + e.g. 288 + ir_fr4region_end: + type: integer + description: | + e.g. 321 + ir_cdr1region_start: + type: integer + description: | + e.g. 39 + ir_cdr1region_end: + type: integer + description: | + e.g. 321 + ir_cdr2region_start: + type: integer + description: | + e.g. 62 + ir_cdr2region_end: + type: integer + description: | + e.g. 134 + ir_cdr3region_start: + type: integer + description: | + e.g. 249 + ir_cdr3region_end: + type: integer + description: | + e.g. 287 + ir_junction_start: + type: integer + description: | + e.g. 246 + ir_junction_end: + type: integer + description: | + e.g. 290 + ir_vregion_mutation_string: + type: string + description: > + e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - + +)|a166>c,I56>L(+ + +)|t172>a,Y58>N(- - + -)|c195>t|c198>g,N66>K(+ - -)|a220>g,S74>G(+ + + -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c| + ir_fr1region_mutation_string: + type: string + description: | + e.g. a41>c|g42>t|c43>g,P15>A(- - -)|g51>t,E17>D(+ - +)| + ir_fr2region_mutation_string: + type: string + description: | + e.g. + ir_fr3region_mutation_string: + type: string + description: > + e.g. c198>g,N66>K(+ - -)|a220>g,S74>G(+ + + -)|a229>t,T77>S(+ - +)|g275>c,S92>T(+ - +)|t279>c|" + ir_cdr1region_mutation_string: + type: string + description: | + e.g. + ir_cdr2region_mutation_string: + type: string + description: | + e.g. a166>c,I56>L(+ + +)|t172>a,Y58>N(- - -)|c195>t|" + ir_cdr3region_mutation_string: + type: string + description: | + e.g. g317>c,R106>T(- - -)|a318>c,R106>T(- - -)|g319>t + ir_annotation_tool: + type: string + description: | + e.g. VQuest \ No newline at end of file diff --git a/ireceptor_summary.yaml b/ireceptor_summary.yaml new file mode 100644 index 0000000..a8ade18 --- /dev/null +++ b/ireceptor_summary.yaml @@ -0,0 +1,93 @@ + # This model defines ancillary information returned by iReceptor + # as part of the sample summary API. + + ireceptor_summary_model: + type: object + properties: + ir_subject_age: + type: integer + description: | + e.g. 1 + ir_sra_run_id: + type: string + description: | + e.g. SRR4102110 + ir_marker_1: + type: string + description: | + e.g. CR19 + ir_marker_2: + type: string + description: | + e.g. CR20 + ir_marker_3: + type: string + description: | + e.g. CR21 + ir_marker_4: + type: string + description: | + e.g. null + ir_marker_5: + type: string + description: | + e.g. null + ir_marker_6: + type: string + description: | + e.g. null + ir_project_sample_note: + type: string + description: > + A note about the sample. + ir_project_id: + type: integer + description: > + Identifier used internally by the repository to identify a + project. + ir_project_parent_id: + type: integer + description: > + Identifier used internally by the repository to identify a + parent/child + relationship between this project and its parent project. + ir_lab_id: + type: integer + description: > + Identifier used internally by the repository to identify a + lab. + ir_disease_state_id: + type: integer + description: > + Identifier used internally by the repository to identify a + an element in the disease state table. + ir_case_control_id: + type: integer + description: > + Identifier used internally by the repository to identify an + element in the case_control table. + ir_sample_id: + type: integer + description: > + Identifier used internally by the repository to identify a + sample. + ir_dna_id: + type: integer + description: > + Identifier used internally by the repository to identify a + DNA type. + ir_project_sample_id: + type: integer + description: > + Identifier used internally by the repository to identify an + association a project with a sample. + ir_sample_subject_id: + type: integer + description: > + Identifier used internally by the repository to identify an + association between a sample and a subject. + ir_sample_source_id: + type: integer + description: > + Identifier used internally by the repository to identify an + association between a sample and a sample source. \ No newline at end of file