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

Minor enhancement: Put the full server version on the API Docs pages #655

Open
colin-e-nhsd opened this issue Sep 7, 2020 · 1 comment

Comments

@colin-e-nhsd
Copy link

The (Swagger?) API documentation pages served up by the server display the API version number (e.g. 3.0) but not the release number of the server code (e.g. 7.8.2). Making the server version readily available would simplify accurate reporting of bugs and feature requests.

My request is to have the server version tag displayed on every API documentation page, ideally in the header.

In the page footer would also work, but as the page header includes other reference information such as the API version and the link to documentation, this seems like the obvious place to put it.

@cmark
Copy link
Member

cmark commented Sep 7, 2020

Hi @colin-e-nhsd,

Thank you for reporting this feature request.
I agree this would be a great addition to the server API docs and we will investigate how this could be integrated.

In the meantime, please refer to the following endpoint to figure out the version of the server you are working with:

GET /snowowl/admin/info

This returns a JSON object like this:

{
  "version": "7.9.0",
  "description": "You Know, for Terminologies",
  "repositories": {
    "items": [...]
  }
}

I hope this helps.

Cheers,
Mark

@cmark cmark self-assigned this Sep 7, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants