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

Create examples of all API responses #31

Closed
2 tasks done
surchs opened this issue Mar 26, 2024 · 3 comments · Fixed by #32
Closed
2 tasks done

Create examples of all API responses #31

surchs opened this issue Mar 26, 2024 · 3 comments · Fixed by #32
Assignees

Comments

@surchs
Copy link
Contributor

surchs commented Mar 26, 2024

It would make using and testing the APIs a big deal easier to have up to date examples of

  • successful response
  • partial failed response
  • failed response

for all of the API routes for the f-API, and expect that 2/3 nodes is protected, and 1/3 nodes are not protected.

We should also provide examples of protected & non-protected responses for n-API repositories.

This is similar to the examples of query tool results in https://github.com/neurobagel/neurobagel_examples.
So we should find a way to provide these and keep them current. Ideally via an automatic process that updates the examples every time the APIs change.

  • make the examples by hand (with script), not recurring
  • provide a script that makes the examples
@alyssadai
Copy link
Contributor

One option is to wait until we re-release the APIs, then generate some temporary examples using the deployed services.

In future we want to do this automatically as we develop.

@alyssadai alyssadai removed the flag:schedule Flag issue that should go on the roadmap or backlog. label Mar 27, 2024
@alyssadai alyssadai added flag:schedule Flag issue that should go on the roadmap or backlog. and removed flag:schedule Flag issue that should go on the roadmap or backlog. labels Apr 18, 2024
Copy link

github-actions bot commented Jul 5, 2024

We want to keep our issues up to date and active. This issue hasn't seen any activity in the last 75 days.
We have applied the _flag:stale label to indicate that this issue should be reviewed again.
When you review, please reread the spec and then apply one of these three options:

  • prioritize: apply the flag:schedule label to suggest moving this issue into the backlog now
  • close: if the issue is no longer relevant, explain why (give others a chance to reply) and then close.
  • archive: sometimes an issue has important information or ideas but we won't work on it soon. In this case
    apply the someday label to show that this won't be prioritized. The stalebot will ignore issues with this
    label in the future. Use sparingly!

@github-actions github-actions bot added the _flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again label Jul 5, 2024
@surchs
Copy link
Contributor Author

surchs commented Aug 9, 2024

We have some (partial) mocks in the query tool: https://github.com/neurobagel/query-tool/blob/main/cypress/fixtures/mocked-responses.ts
and the interactive docs have a generic example of a successful response: https://api.neurobagel.org/docs#/query/get_query_query__get

@surchs surchs changed the title Create Examples of all API responses Create Examples of all federation-API responses Aug 12, 2024
@alyssadai alyssadai self-assigned this Aug 20, 2024
@alyssadai alyssadai transferred this issue from neurobagel/planning Aug 20, 2024
@alyssadai alyssadai changed the title Create Examples of all federation-API responses Create examples of all API responses Aug 20, 2024
@alyssadai alyssadai moved this from Implement - Active to Implement - Done in Neurobagel Aug 21, 2024
@alyssadai alyssadai moved this from Implement - Done to Review - Active in Neurobagel Aug 22, 2024
@alyssadai alyssadai removed the _flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again label Aug 22, 2024
@github-project-automation github-project-automation bot moved this from Review - Active to Review - Done in Neurobagel Aug 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

2 participants