Add version data to /api/ response

[dannycohen]

Add the ServiceControl version number to the SC /api/ response (http://localhost:33333/API/)

Notes:

1. When checking for updates to ServiceControl, there's a need to compare the newly available version of ServiceControl in the Particular.net website (see https://github.com/Particular/Website.Backend/issues/133) to the existing version of ServiceControl (see Check for ServiceControl Updates ServicePulse#23).
2. The current /api/ response (http://localhost:33333/API/) does not include a version identifier for the ServiceControl instance:

{"audit_url":"http://localhost:33333/api/audit/{?page,per_page,direction,sort}"
,"endpoints_audit_url":"http://localhost:33333/api/endpoints/{name}/audit/{?page,per_page,direction,sort}"
,"endpoints_url":"http://localhost:33333/api/endpoints"
,"errors_url":"http://localhost:33333/api/errors/{?page,per_page,direction,sort}"
,"endpoints_error_url":"http://localhost:33333/api/endpoints/{name}/errors/{?page,per_page,direction,sort}"
,"message_search_url":"http://localhost:33333/api/messages/search/{keyword}/{?page,per_page,direction,sort}"
,"endpoints_message_search_url":"http://localhost:33333/api/endpoints/{name}/messages/search/{keyword}/{?page,per_page,direction,sort}"
,"endpoints_messages_url":"http://localhost:33333/api/endpoints/{name}/messages/{?page,per_page,direction,sort}"
,"name":"Particular ServiceControl","description":"Description for Particular ServiceControl"}

[andreasohlund]

lets set it as a http header

[dannycohen]

lets set it as a http header

I see value in setting this as a body value.
One of the most used support scenarios when encountering a problem with SI to connect to SC would be to ask the user to open the browser and do an HTTP GET on http://localhost:33333/API/
This is the easiest way to know whether SC is installed, responsive and which version it is.
Adding it as an HTTP header will make it harder to get the data (not much harder, but harder enough to annoy us when waiting for it...)

So Lets see if we can also add it as a body value.
Thoughts ?

[andreasohlund]

Lets await the mighty John "Fielding" Simons reponse! :)

On Thu, Oct 17, 2013 at 2:22 PM, Danny Cohen notifications@github.comwrote:

lets set it as a http header

I see value in setting this as a body value.
One of the most used support scenarios when encountering a problem with SI
to connect to SC would be to ask the user to open the browser and do an
HTTP GET on http://localhost:33333/API/
This is the easiest way to know whether SC is installed, responsive and
which version it is.
Adding it as an HTTP header will make it harder to get the data (not much
harder, but harder enough to annoy us when waiting for it...)

So Lets see if we can also add it as a body value.
Thoughts ?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/72#issuecomment-26499414
.

[dannycohen]

@andreasohlund -
My bad - the version id is already defined as an HTTP header:
e.g.: Response Header: X-Particular-Version : 1.0.0-unstable89

The question is whether you agree with me that adding it as an easily visible body value would make our support life easier ?

[andreasohlund]

I'd say since SI can show it to them and dev tools are pretty much included
in every browser (F12) this is good enough?

On Thu, Oct 17, 2013 at 2:25 PM, Danny Cohen notifications@github.comwrote:

@andreasohlund https://github.com/andreasohlund -
My bad - the version id is already defined as an HTTP header:
e.g.: Response Header: X-Particular-Version : 1.0.0-unstable89

The question is whether you agree with me that adding it as an easily
visible body value would make our support life easier ?

—
Reply to this email directly or view it on GitHubhttps://github.com//issues/72#issuecomment-26499570
.

[dannycohen]

OK, I'm convinced. Thanks!