659414 - Provide environment profile info as nested XML/JSON in core response, rather than requiring separate API call

Status: VERIFIED FIXED

(Mozilla QA :: Case Conductor-Platform, enhancement)

Description

[Carl Meyer (:carljm)]

From the UI perspective, it would be preferable if environment groups and their member environments were provided as nested XML/JSON in the basic platform response for objects with environment profiles, rather than requiring a separate API call per object to fetch environment profile data. When displaying a list of objects with environment profile data, this makes the difference between 1 API call and O(N) API calls.

Comment 1

[Carl Meyer (:carljm)]

This change may turn out to be quite high priority once we observe the system under real-world usage loads. I'm addressing it currently with heavy caching of API call results, but in order to maintain freshness of data, which is important for such an interactive application, these caches have to be aggressively invalidated on write. So if write load is high, the caching may not have much impact.

For now, though, I'm leaving this off the 1.0 milestone, as it isn't strictly necessary for implementing any feature on the 1.0 list.

Comment 2

[Vadim]

I don't think it's OK to populate all the environment data all the time just because the resulting object has it...In the future we may implement another set of calls, which would return this data with the base object, when specifically requested...

Comment 3

[Vadim]

I'm going to add similar endpoints to all environment dependable entities, similar to this:

https://localhost/tcm/services/v2/rest/testruns/1/environmentgroups/exploded/

So, if you need to get all the env info in one call you can get it there....

Comment 4

[Vadim]

added new GET endpoints for all profile containing entities, i.e. 
/products/{id}/environmentgroups/exploded/