galaxy icon indicating copy to clipboard operation
galaxy copied to clipboard

[WIP] add an 'api' endpoint /api/docs/ to display all(?) available api urls…

Open scholtalbers opened this issue 6 years ago • 4 comments

After the idea of the DRF browsable API, this would add an 'api' endpoint /api/docs/ to display all(?) available api urls/methods and their docstring.

Currently this would look like below and obviously there is room for styling/cleanup - or rewrite.

screen shot 2018-01-04 at 13 46 30

scholtalbers avatar Jan 04 '18 12:01 scholtalbers

I like this idea very much.

martenson avatar Jan 04 '18 16:01 martenson

@scholtalbers is this related to https://github.com/galaxyproject/galaxy/issues/3211?

bgruening avatar Jan 04 '18 16:01 bgruening

@bgruening I wasn't aware of that ticket anymore, but I guess its related. This attempt doesn't follow any standard (nor did I try to), but just bluntly throws information together to get a list of available URLs. I actually wanted to have this at /api/, as that is currently a non-existing endpoint which bugged me a few times, but failed to figure out how..

scholtalbers avatar Jan 04 '18 17:01 scholtalbers

@galaxybot test this

mvdbeek avatar Jan 04 '18 18:01 mvdbeek

With the OpenAPI docs available at <galaxy_url>/api/docs , this is is not needed any more.

nsoranzo avatar Sep 17 '22 07:09 nsoranzo