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

Add examples for results API endpoints #73

Closed
vprusso opened this issue May 16, 2023 · 9 comments · Fixed by #75
Closed

Add examples for results API endpoints #73

vprusso opened this issue May 16, 2023 · 9 comments · Fixed by #75
Assignees
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@vprusso
Copy link
Contributor

vprusso commented May 16, 2023

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:

  • result_metric_names
  • result_get
  • result_add
@vprusso vprusso added enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed labels May 16, 2023
@anushkrishnav
Copy link

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

@WrathfulSpatula
Copy link
Contributor

@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
Copy link
Contributor

AVDiv commented Jun 9, 2023

Hey,
I would like to work on this

@vprusso
Copy link
Contributor Author

vprusso commented Jun 9, 2023

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
Copy link
Contributor

AVDiv commented Jun 11, 2023

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

@vprusso
Copy link
Contributor Author

vprusso commented Jun 11, 2023

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

@AVDiv
Copy link
Contributor

AVDiv commented Jun 12, 2023

Thank you @vprusso

@WrathfulSpatula
Copy link
Contributor

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

@natestemen
Copy link
Member

natestemen commented Jun 12, 2023

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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants