unitaryfund / metriq-client

Fork of papers-with-code client
https://metriq.info
Apache License 2.0
3 stars 9 forks source link

Add examples for results API endpoints #73

Closed vprusso closed 1 year ago

vprusso commented 1 year ago

At present there are no examples in the examples/ directory for the result API endpoints. Specific examples for this endpoint should include the existing result routes. Namely:

anushkrishnav commented 1 year ago

I want to work on this , can you assign it to me? Can you provide more information on this issue ?

WrathfulSpatula commented 1 year ago

@anushkrishnav Results endpoints are defined here in the back end controller: https://github.com/unitaryfund/metriq-api/blob/main/metriq-api/controller/resultController.js

The point of the issue is to write examples, just like the existing examples in the examples/ directory, demonstrating each of the endpoints in resultController.js. (The controller routes will accept JSON in a POST request body, if the route is POST verb. GET routes accept route URL parameters.)

Is that clear? Let me know if I can offer more help!

AVDiv commented 1 year ago

Hey, I would like to work on this

vprusso commented 1 year ago

Hi @AVDiv. It looks like @anushkrishnav expressed an interest to work on this issue, but that was two weeks ago. If you'd like to go ahead and put in a PR for this instead, go on ahead!

AVDiv commented 1 year ago

Hi @vprusso I added an PR, please check if any improvements to be done.

vprusso commented 1 year ago

Thanks for the ping, @AVDiv . Replied on the MR thread. Let me know if you have any questions!

AVDiv commented 1 year ago

Thank you @vprusso

WrathfulSpatula commented 1 year ago

@vprusso Take note, @AVDiv wasn't assigned at the time this was closed. We might want to check with @natestemen about the bounty.

natestemen commented 1 year ago

All looks good here. Once and issue is closed, then we look at who is assigned, so it doesn't matter the order in which things happen. Thanks for checking in!