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

Embed the Swagger API Page into the larger cBioPortal shell #2969

Closed
ecerami opened this issue Aug 11, 2017 · 3 comments
Closed

Embed the Swagger API Page into the larger cBioPortal shell #2969

ecerami opened this issue Aug 11, 2017 · 3 comments
Assignees
Labels

Comments

@ecerami
Copy link
Contributor

ecerami commented Aug 11, 2017

We need to emded this page: http://www.cbioportal.org/api/swagger-ui.html into the regular cBioPortal shell.

@jjgao jjgao added this to the public-api-release milestone Jul 20, 2019
@ecerami
Copy link
Contributor Author

ecerami commented Feb 29, 2020

@jjgao @inodb @alisman: I thought I could also try this one. Maybe I could just use an iframe?

@ecerami ecerami self-assigned this Feb 29, 2020
@inodb
Copy link
Member

inodb commented Mar 3, 2020

@ecerami I'm not sure how easy this would be actually. There are links to particular endpoints e.g. https://www.cbioportal.org/api/swagger-ui.html#/C._Patients/getAllPatientsUsingGET. I don't think that works with IFrames?

The generated API seems more like a full reference than user friendly API documentation. So maybe it is fine that it's not inside the cBioPortal shell? We could e.g. write new documentation that fits in the cBioPortal shell. Then point to cbioportal.org/api for full reference of all endpoints. At the top top of the reference page we could point to our "user friendly docs". Was thinking to do some general overview of the API and specific examples with Jupyter Notebooks for Python and R (see also epic: cBioPortal/icebox#564)

@ecerami
Copy link
Contributor Author

ecerami commented Mar 3, 2020

@inodb yeah, sounds good to me. I will close for now, and we can always revisit later.

@ecerami ecerami closed this as completed Mar 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants