Make API version and node info discoverable

[rmanaem]

Right now, there is no way to find out what API version is currently running in deployment from the UI which makes it hard for us and the user to know what feature/issues are to be expected.

[surchs]

Thanks @rmanaem. Couple quick ideas

We might show the version

• on the interactive docs / API landing page
• in a special /info or /nodeinfo endpoint
• in the openapi.json of the API - there it is currently wrong, i.e. https://federate.neurobagel.org/openapi.json

We should consider

• differentiating the version of the backend service that exposes the API (i.e. the fastapi app) from the version of the API specification (i.e. the pydantic model in that repo)

I would not yet decide that the info needs to be in one place or another. But we do need to expose the version info - and keep it up to date

[alyssadai]

Expanding on this, we've discussed lifting out the node "mode" (i.e. if subject-level records are protected or not) from the dataset-level part of API query responses (records_protected field) to a to-be-created node info endpoint as well.

[faizavk]

Hi @rmanaem, I would love to pick this up!

Reading through the thread, it sounds like the best approach is to create a dedicated /info endpoint that returns both the current API version (differentiating the backend service version from the API spec if needed, as @surchs mentioned) as well as the records_protected node mode that @alyssadai brought up.

If this approach still aligns with what the team needs, I can start putting together a PR for this!

[github-actions]

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!