search

RallyTools / RallyRestToolkitForRuby

A toolkit wrapping Rally's REST webservice for Ruby
MIT License
47 stars 32 forks source link

project_scope_up, project_scope down defaults true #54

Closed yithian closed 8 years ago

yithian commented 8 years ago

according to the rally webservice api docs0 the projectScopeDown and projectScopeUp parameters should default to true

yithian commented 8 years ago

@abrockett @ctudor-rally @dawsmith8 @klehman-rally @krmorse @markmsmith-work - Any chance of getting this merged in?

klehman-rally commented 8 years ago

We're going to decline this pull request. We've got some installed base that we're not prepared to have this functionality included as well as customers using this toolkit with large numbers of projects for whom performance would likely suffer and has the potential to place an unnecessary query operation load on our SaaS servers. There are workarounds that could be employed so that a toolkit user could pass a query_hash to the RallyQuery constructor the with the desired project_scope_up and project_scope_down boolean values. While the proposed change might make sense for subscribers with a relatively small workspace/project universe, we've seen that having project_scope_down (more so) and project_scope_up defaulting to true have undesirable effects for subscribers with a large universe of workspaces and projects.

yithian commented 8 years ago

Fair enough.

It would be nice if either the api documentation or the ruby gem documentation would reflect this behavior though. From the Web Services API Documentation introduction:

projectScopeUp Include parent projects above the one specified. Default is true. Example: projectScopeUp=false

projectScopeDown Include child projects below the specified one. Default is true. Example: projectScopeDown=true

I spent a bunch of time trying to figure out why the code I wrote wasn't behaving as the API documentation described.