Skip to content

Commit 6810ed9

Browse files
committed
Update api docs
1 parent 1d3d73e commit 6810ed9

File tree

10 files changed

+5634
-12851
lines changed

10 files changed

+5634
-12851
lines changed

packages/cbioportal-ts-api-client/src/generated/CBioPortalAPI-docs.json

Lines changed: 4049 additions & 4483 deletions
Large diffs are not rendered by default.

packages/cbioportal-ts-api-client/src/generated/CBioPortalAPI.ts

Lines changed: 112 additions & 73 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,8 @@ export type CancerStudy = {
6060

6161
'referenceGenome': string
6262

63+
'resourceCounts': Array < ResourceCount >
64+
6365
'rppaSampleCount': number
6466

6567
'sequencedSampleCount': number
@@ -256,6 +258,8 @@ export type GenericAssayData = {
256258

257259
'patientId': string
258260

261+
'patientLevel': boolean
262+
259263
'sampleId': string
260264

261265
'stableId': string
@@ -302,6 +306,12 @@ export type GenericAssayMetaFilter = {
302306
export type Info = {
303307
'dbVersion': string
304308

309+
'derivedTableVersion': string
310+
311+
'geneTableVersion': string
312+
313+
'genesetVersion': string
314+
305315
'gitBranch': string
306316

307317
'gitCommitId': string
@@ -462,9 +472,9 @@ export type MutationMultipleStudyFilter = {
462472

463473
};
464474
export type NamespaceAttribute = {
465-
'outerKey': string
475+
'innerKey': string
466476

467-
'innerKey': string
477+
'outerKey': string
468478

469479
};
470480
export type NumericGeneMolecularData = {
@@ -510,6 +520,28 @@ export type PatientIdentifier = {
510520

511521
'studyId': string
512522

523+
};
524+
export type ResourceCount = {
525+
'customMetaData': string
526+
527+
'description': string
528+
529+
'displayName': string
530+
531+
'openByDefault': boolean
532+
533+
'patientCount': number
534+
535+
'priority': string
536+
537+
'resourceId': string
538+
539+
'resourceType': "STUDY" | "SAMPLE" | "PATIENT"
540+
541+
'sampleCount': number
542+
543+
'studyId': string
544+
513545
};
514546
export type Sample = {
515547
'copyNumberSegmentPresent': boolean
@@ -4073,6 +4105,83 @@ export default class CBioPortalAPI {
40734105
return response.body;
40744106
});
40754107
};
4108+
fetchNamespaceUsingURL(parameters: {
4109+
'studyIds': Array < string > ,
4110+
$queryParameters ? : any
4111+
}): string {
4112+
let queryParameters: any = {};
4113+
let path = '/api/namespace-attributes/fetch';
4114+
4115+
if (parameters.$queryParameters) {
4116+
Object.keys(parameters.$queryParameters).forEach(function(parameterName) {
4117+
var parameter = parameters.$queryParameters[parameterName];
4118+
queryParameters[parameterName] = parameter;
4119+
});
4120+
}
4121+
let keys = Object.keys(queryParameters);
4122+
return this.domain + path + (keys.length > 0 ? '?' + (keys.map(key => key + '=' + encodeURIComponent(queryParameters[key])).join('&')) : '');
4123+
};
4124+
4125+
/**
4126+
* Fetch namespace attributes
4127+
* @method
4128+
* @name CBioPortalAPI#fetchNamespaceUsing
4129+
* @param {} studyIds - A web service for supplying JSON formatted data to cBioPortal clients. Please note that this API is currently in beta and subject to change.
4130+
*/
4131+
fetchNamespaceUsingWithHttpInfo(parameters: {
4132+
'studyIds': Array < string > ,
4133+
$queryParameters ? : any,
4134+
$domain ? : string
4135+
}): Promise < request.Response > {
4136+
const domain = parameters.$domain ? parameters.$domain : this.domain;
4137+
const errorHandlers = this.errorHandlers;
4138+
const request = this.request;
4139+
let path = '/api/namespace-attributes/fetch';
4140+
let body: any;
4141+
let queryParameters: any = {};
4142+
let headers: any = {};
4143+
let form: any = {};
4144+
return new Promise(function(resolve, reject) {
4145+
headers['Accept'] = 'application/octet-stream';
4146+
headers['Content-Type'] = 'application/json';
4147+
4148+
if (parameters['studyIds'] !== undefined) {
4149+
body = parameters['studyIds'];
4150+
}
4151+
4152+
if (parameters['studyIds'] === undefined) {
4153+
reject(new Error('Missing required parameter: studyIds'));
4154+
return;
4155+
}
4156+
4157+
if (parameters.$queryParameters) {
4158+
Object.keys(parameters.$queryParameters).forEach(function(parameterName) {
4159+
var parameter = parameters.$queryParameters[parameterName];
4160+
queryParameters[parameterName] = parameter;
4161+
});
4162+
}
4163+
4164+
request('POST', domain + path, body, headers, queryParameters, form, reject, resolve, errorHandlers);
4165+
4166+
});
4167+
};
4168+
4169+
/**
4170+
* Fetch namespace attributes
4171+
* @method
4172+
* @name CBioPortalAPI#fetchNamespaceUsing
4173+
* @param {} studyIds - A web service for supplying JSON formatted data to cBioPortal clients. Please note that this API is currently in beta and subject to change.
4174+
*/
4175+
fetchNamespaceUsing(parameters: {
4176+
'studyIds': Array < string > ,
4177+
$queryParameters ? : any,
4178+
$domain ? : string
4179+
}): Promise < Array < NamespaceAttribute >
4180+
> {
4181+
return this.fetchNamespaceUsingWithHttpInfo(parameters).then(function(response: request.Response) {
4182+
return response.body;
4183+
});
4184+
};
40764185
getAllPatientsUsingGETURL(parameters: {
40774186
'keyword' ? : string,
40784187
'projection' ? : "ID" | "SUMMARY" | "DETAILED" | "META",
@@ -7230,74 +7339,4 @@ export default class CBioPortalAPI {
72307339
return response.body;
72317340
});
72327341
};
7233-
7234-
/**
7235-
* Fetch namespace attributes
7236-
* @method
7237-
* @name CBioPortalAPI#fetchNamespaceAttributesUsingPOST
7238-
* @param {string} projection - Level of detail of the response
7239-
* @param {} studyIds - A web service for supplying JSON formatted data to cBioPortal clients. Please note that this API is currently in beta and subject to change.
7240-
*/
7241-
fetchNamespaceAttributesUsingPOSTWithHttpInfo(parameters: {
7242-
'projection' ? : "ID" | "SUMMARY" | "DETAILED" | "META",
7243-
'studyIds': Array < string > ,
7244-
$queryParameters ? : any,
7245-
$domain ? : string
7246-
}): Promise < request.Response > {
7247-
const domain = parameters.$domain ? parameters.$domain : this.domain;
7248-
const errorHandlers = this.errorHandlers;
7249-
const request = this.request;
7250-
let path = '/api/namespace-attributes/fetch';
7251-
let body: any;
7252-
let queryParameters: any = {};
7253-
let headers: any = {};
7254-
let form: any = {};
7255-
return new Promise(function(resolve, reject) {
7256-
headers['Accept'] = 'application/json';
7257-
headers['Content-Type'] = 'application/json';
7258-
7259-
if (parameters['projection'] !== undefined) {
7260-
queryParameters['projection'] = parameters['projection'];
7261-
}
7262-
7263-
if (parameters['studyIds'] !== undefined) {
7264-
body = parameters['studyIds'];
7265-
}
7266-
7267-
if (parameters['studyIds'] === undefined) {
7268-
reject(new Error('Missing required parameter: studyIds'));
7269-
return;
7270-
}
7271-
7272-
if (parameters.$queryParameters) {
7273-
Object.keys(parameters.$queryParameters).forEach(function(parameterName) {
7274-
var parameter = parameters.$queryParameters[parameterName];
7275-
queryParameters[parameterName] = parameter;
7276-
});
7277-
}
7278-
7279-
request('POST', domain + path, body, headers, queryParameters, form, reject, resolve, errorHandlers);
7280-
7281-
});
7282-
};
7283-
7284-
/**
7285-
* Fetch namespace attributes
7286-
* @method
7287-
* @name CBioPortalAPI#fetchNamespaceAttributesUsingPOST
7288-
* @param {string} projection - Level of detail of the response
7289-
* @param {} studyIds - A web service for supplying JSON formatted data to cBioPortal clients. Please note that this API is currently in beta and subject to change.
7290-
*/
7291-
fetchNamespaceAttributesUsingPOST(parameters: {
7292-
'projection' ? : "ID" | "SUMMARY" | "DETAILED" | "META",
7293-
'studyIds': Array < string > ,
7294-
$queryParameters ? : any,
7295-
$domain ? : string
7296-
}): Promise < Array < NamespaceAttribute >
7297-
> {
7298-
return this.fetchNamespaceAttributesUsingPOSTWithHttpInfo(parameters).then(function(response: request.Response) {
7299-
return response.body;
7300-
});
7301-
};
7302-
7303-
}
7342+
}

0 commit comments

Comments
 (0)