diff --git a/jass/swagger/swagger.yaml b/jass/swagger/swagger.yaml index 458c10009610cc216b94dc0507e78a9eb30dc57c..6a4f94ca2bbc74a096a0a408a52ac39a418612eb 100644 --- a/jass/swagger/swagger.yaml +++ b/jass/swagger/swagger.yaml @@ -141,11 +141,15 @@ paths: end: description: end position of the region type: string + to_init: + description: first call to local_projects ? ("1"=yes) + type: string required: - phenotypeID - chromosome - start - end + - to_init responses: "200": description: Project created @@ -530,6 +534,86 @@ paths: ID,rs545945172,rs371628865,rs61769339,rs539032812,rs12238997,rs189800799 z_IHEC_MONOP,-0.3623372836601329,-0.429856541533544,-0.8457360635272954,-0.9809852811227732,-0.6936527568935886,0.4382385293216385 z_RA_RA,,,,,, + "/projects/{projectID}/gene_exon": + get: + description: Retrieve gene and exon data for the selected region + operationId: get_project_gene_exon_data + parameters: + - name: projectID + in: path + description: project ID + required: true + schema: + type: string + example: "bca9d414e0f9a67b9e0d2131a47c316c" + responses: + "200": + description: | + genes and exons data in CSV format + content: + text/csv; charset=utf-8: + schema: + type: string + title: Genes and exons data + example: | + ,GeneID,exon_label,exon_start,exon_end,gene_label,gene_start,gene_end,gene_direction,gene_biotype + 1983,55229,NM_018216.4-9,2449603,2449703,PANK4,2439976,2458035,-,protein_coding + 1984,55229,NM_018216.4-8,2449955,2450036,PANK4,2439976,2458035,-,protein_coding + 1985,55229,NM_018216.4-7,2450582,2450763,PANK4,2439976,2458035,-,protein_coding + 1986,55229,NM_018216.4-6,2451240,2451393,PANK4,2439976,2458035,-,protein_coding + 1987,55229,NM_018216.4-5,2451761,2451853,PANK4,2439976,2458035,-,protein_coding + 1988,55229,NM_018216.4-4,2452162,2452345,PANK4,2439976,2458035,-,protein_coding + 1989,55229,NM_018216.4-3,2452540,2452754,PANK4,2439976,2458035,-,protein_coding + 1990,55229,NM_018216.4-2,2453157,2453239,PANK4,2439976,2458035,-,protein_coding + 1991,55229,NM_018216.4-1,2457903,2458035,PANK4,2439976,2458035,-,protein_coding + "/projects/{projectID}/error_msg": + get: + description: | + Retrieve the functional error messages stored in log files + operationId: get_error_msg + parameters: + - name: projectID + in: path + description: project ID + required: true + schema: + type: string + example: "bca9d414e0f9a67b9e0d2131a47c316c" + responses: + "200": + description: | + Generation of the concatenation of all functional error messages + content: + text/csv; charset=utf-8: + schema: + type: string + title: error message + example: | + There is no SNP in the selected region + "/projects/{projectID}/dispo_gene_exon": + get: + description: | + Test if genes and exons data are available + operationId: get_dispo_gene_exon + parameters: + - name: projectID + in: path + description: project ID + required: true + schema: + type: string + example: "bca9d414e0f9a67b9e0d2131a47c316c" + responses: + "200": + description: | + Indicates whether gene and exon data is available + content: + text/csv; charset=utf-8: + schema: + type: string + title: return code + example: | + READY components: schemas: Phenotype: