search across multiple repositories

[shiftkey]

Fixes #834

This is a breaking API change to support being able to search across repositories. We currently have an ctor overload that accepts an owner and name for the repository:

var request = new SearchIssuesRequest("windows", "aspnet", "dnx");

The change here is adding a public property Repos which accepts a collection of owner/name strings (i've added some validation to ensure these are formatted correctly for the server):

var request = new SearchIssuesRequest("windows");
request.Repos = new Collection<string> {
    "aspnet/dnx",
    "aspnet/dnvm"
};

This replaces the old Repo property, which was constrained to one string:

var request = new SearchIssuesRequest("windows");
request.Repo = "aspnet/dnx";

Rather than carry around both Repo and Repos for a period of time (leading to possible confusion), I'm just going to 🔥 the property here - I think many people would prefer to just use the Repos property anyway...

• confirm regex rules match our repository rules
• make changes in SearchIssueRequest
• make changes in SearchCodeRequest
• a more-friendly abstraction than just a collection?
• document how to search issues (with some examples)
• document how to search pull requests (with some examples)
• [ ] document an example of searching code
• wtf ci?

Rendered docs

cc @DamianEdwards @M-Zuber

[shiftkey]

@DamianEdwards @M-Zuber writing up a walkthrough of the search options available - how does this read?

[M-Zuber]

It reads quite nicely.
The examples are very nice to have, a bonus would be a simple run down of the properties available even if they don't have examples. (I would be willing to try and do a PR once this in)

[khellang]

What about creating a specialized object for holding the repos? This way you could use a custom collection initializer, forcing the user to specify both owner and repo name.

[shiftkey]

@khellang good point - if I'm breaking the API here I'll see if I can do better than just a collection

[M-Zuber]

Preaching to the choir, but I fully agree with @khellang

[khellang]

Sent a PR at #842

[haacked]

This is looking pretty good. Anything needing specific review?

[shiftkey]

@haacked not really, I should write an example for SearchCodeRequest.cs because that's impacted by this change. But I think everything in the code is ✨. I'll add a note.

[haacked]

@shiftkey should I merge this?

[shiftkey]

@haacked sure, I just like putting docs in front of me - because otherwise they'll never get written 🚎

[haacked]

✨ all around.