Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update API docs #4666

Merged
merged 1 commit into from
Jul 20, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -2450,6 +2450,43 @@
}
}
},
"/structuralvariant-counts/fetch": {
"post": {
"tags": [
"Study View"
],
"summary": "Fetch structural variant genes by study view filter",
"operationId": "fetchStructuralVariantCountsUsingPOST",
"consumes": [
"application/json"
],
"produces": [
"application/json"
],
"parameters": [
{
"in": "body",
"name": "studyViewFilter",
"description": "Study view filter",
"required": true,
"schema": {
"$ref": "#/definitions/StudyViewFilter"
}
}
],
"responses": {
"200": {
"description": "OK",
"schema": {
"type": "array",
"items": {
"$ref": "#/definitions/AlterationCountByStructuralVariant"
}
}
}
}
}
},
"/structuralvariant-genes/fetch": {
"post": {
"tags": [
Expand Down Expand Up @@ -3356,9 +3393,22 @@
"type": "integer",
"format": "int32"
},
"entrezGeneIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"hugoGeneSymbol": {
"type": "string"
},
"hugoGeneSymbols": {
"type": "array",
"items": {
"type": "string"
}
},
"matchingGenePanelIds": {
"type": "array",
"uniqueItems": true,
Expand All @@ -3380,10 +3430,68 @@
"totalCount": {
"type": "integer",
"format": "int32"
},
"uniqueEventKey": {
"type": "string"
}
},
"title": "AlterationCountByGene"
},
"AlterationCountByStructuralVariant": {
"type": "object",
"properties": {
"entrezGeneIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"gene1EntrezGeneId": {
"type": "integer",
"format": "int32"
},
"gene1HugoGeneSymbol": {
"type": "string"
},
"gene2EntrezGeneId": {
"type": "integer",
"format": "int32"
},
"gene2HugoGeneSymbol": {
"type": "string"
},
"hugoGeneSymbols": {
"type": "array",
"items": {
"type": "string"
}
},
"matchingGenePanelIds": {
"type": "array",
"uniqueItems": true,
"items": {
"type": "string"
}
},
"numberOfAlteredCases": {
"type": "integer",
"format": "int32"
},
"numberOfProfiledCases": {
"type": "integer",
"format": "int32"
},
"totalCount": {
"type": "integer",
"format": "int32"
},
"uniqueEventKey": {
"type": "string"
}
},
"title": "AlterationCountByStructuralVariant"
},
"AlterationEnrichment": {
"type": "object",
"required": [
Expand Down Expand Up @@ -4044,9 +4152,22 @@
"type": "integer",
"format": "int32"
},
"entrezGeneIds": {
"type": "array",
"items": {
"type": "integer",
"format": "int32"
}
},
"hugoGeneSymbol": {
"type": "string"
},
"hugoGeneSymbols": {
"type": "array",
"items": {
"type": "string"
}
},
"matchingGenePanelIds": {
"type": "array",
"uniqueItems": true,
Expand All @@ -4068,6 +4189,9 @@
"totalCount": {
"type": "integer",
"format": "int32"
},
"uniqueEventKey": {
"type": "string"
}
},
"title": "CopyNumberCountByGene"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,12 @@ type CallbackHandler = (err: any, res ? : request.Response) => void;
export type AlterationCountByGene = {
'entrezGeneId': number

'entrezGeneIds': Array < number >

'hugoGeneSymbol': string

'hugoGeneSymbols': Array < string >

'matchingGenePanelIds': Array < string >

'numberOfAlteredCases': number
Expand All @@ -16,6 +20,32 @@ export type AlterationCountByGene = {

'totalCount': number

'uniqueEventKey': string

};
export type AlterationCountByStructuralVariant = {
'entrezGeneIds': Array < number >

'gene1EntrezGeneId': number

'gene1HugoGeneSymbol': string

'gene2EntrezGeneId': number

'gene2HugoGeneSymbol': string

'hugoGeneSymbols': Array < string >

'matchingGenePanelIds': Array < string >

'numberOfAlteredCases': number

'numberOfProfiledCases': number

'totalCount': number

'uniqueEventKey': string

};
export type AlterationEnrichment = {
'counts': Array < CountSummary >
Expand Down Expand Up @@ -306,8 +336,12 @@ export type CopyNumberCountByGene = {

'entrezGeneId': number

'entrezGeneIds': Array < number >

'hugoGeneSymbol': string

'hugoGeneSymbols': Array < string >

'matchingGenePanelIds': Array < string >

'numberOfAlteredCases': number
Expand All @@ -318,6 +352,8 @@ export type CopyNumberCountByGene = {

'totalCount': number

'uniqueEventKey': string

};
export type CopyNumberCountIdentifier = {
'alteration': number
Expand Down Expand Up @@ -5805,6 +5841,83 @@ export default class CBioPortalAPIInternal {
return response.body;
});
};
fetchStructuralVariantCountsUsingPOSTURL(parameters: {
'studyViewFilter': StudyViewFilter,
$queryParameters ? : any
}): string {
let queryParameters: any = {};
let path = '/structuralvariant-counts/fetch';

if (parameters.$queryParameters) {
Object.keys(parameters.$queryParameters).forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
}
let keys = Object.keys(queryParameters);
return this.domain + path + (keys.length > 0 ? '?' + (keys.map(key => key + '=' + encodeURIComponent(queryParameters[key])).join('&')) : '');
};

/**
* Fetch structural variant genes by study view filter
* @method
* @name CBioPortalAPIInternal#fetchStructuralVariantCountsUsingPOST
* @param {} studyViewFilter - Study view filter
*/
fetchStructuralVariantCountsUsingPOSTWithHttpInfo(parameters: {
'studyViewFilter': StudyViewFilter,
$queryParameters ? : any,
$domain ? : string
}): Promise < request.Response > {
const domain = parameters.$domain ? parameters.$domain : this.domain;
const errorHandlers = this.errorHandlers;
const request = this.request;
let path = '/structuralvariant-counts/fetch';
let body: any;
let queryParameters: any = {};
let headers: any = {};
let form: any = {};
return new Promise(function(resolve, reject) {
headers['Accept'] = 'application/json';
headers['Content-Type'] = 'application/json';

if (parameters['studyViewFilter'] !== undefined) {
body = parameters['studyViewFilter'];
}

if (parameters['studyViewFilter'] === undefined) {
reject(new Error('Missing required parameter: studyViewFilter'));
return;
}

if (parameters.$queryParameters) {
Object.keys(parameters.$queryParameters).forEach(function(parameterName) {
var parameter = parameters.$queryParameters[parameterName];
queryParameters[parameterName] = parameter;
});
}

request('POST', domain + path, body, headers, queryParameters, form, reject, resolve, errorHandlers);

});
};

/**
* Fetch structural variant genes by study view filter
* @method
* @name CBioPortalAPIInternal#fetchStructuralVariantCountsUsingPOST
* @param {} studyViewFilter - Study view filter
*/
fetchStructuralVariantCountsUsingPOST(parameters: {
'studyViewFilter': StudyViewFilter,
$queryParameters ? : any,
$domain ? : string
}): Promise < Array < AlterationCountByStructuralVariant >
> {
return this.fetchStructuralVariantCountsUsingPOSTWithHttpInfo(parameters).then(function(response: request.Response) {
return response.body;
});
};
fetchStructuralVariantGenesUsingPOSTURL(parameters: {
'studyViewFilter': StudyViewFilter,
$queryParameters ? : any
Expand Down