Create examples of all API responses

[surchs]

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.

• [x] make the examples by hand (with script), not recurring
• [x] provide a script that makes the examples

[alyssadai]

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.

[github-actions[bot]]

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!

[surchs]

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