-
Notifications
You must be signed in to change notification settings - Fork 0
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
Comments
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. |
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 some (partial) mocks in the query tool: https://github.com/neurobagel/query-tool/blob/main/cypress/fixtures/mocked-responses.ts |
It would make using and testing the APIs a big deal easier to have up to date examples of
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.
The text was updated successfully, but these errors were encountered: