GetService returns a Service with null version

[stefangluszek]

Client.GetService returns Service and according to the documentation it should have ActiveVersion but that is always null. This is because the underlying API for service does not return the version. There is a similar method GetServiceDetails that returns ServiceDetail which will have both ActiveVersion and Version fields. This is confusing as the readers of the documentation would expect Service returned by GetService to have a proper Version set.

[Integralist]

Thanks @stefangluszek for raising this issue, this issue was raised previously for which you can see the comment thread here:
#242 (comment)

[stefangluszek]

True, but I still think this is a common source of confusion and by reading the documentation you assume the version will be there but it's not. Perhaps it would be enough to include this information in the docstring for GetService. Something like:
"The Service object returned by this function might be missing some fields, such as ActiveVersion, use GetServiceDetails instead."
Or at lease explain when you should use GetService and when GetServiceDetails. Or just get rid of GetService altogether if it provides no additional value and GetServiceDetails could be used instead.

[karenetheridge]

We're working on updating the public documentation.

[karenetheridge]

as per https://developer.fastly.com/reference/api/services/service/#search-service, active version is not included in this endpoint. The associated versions are provided in array though, and exactly one of those versions will have "active":true.

[Integralist]

I'm going to close this PR as it looks to be something that will be clarified via the public documentation.