Refactor CreateCollectionBuilder

[rylev]

This is a suggested way of addressing #129.

This particular builder is the builder in Cosmos with the most required fields. Even then, I think it's still a very reasonable API.

Docs

API Usage

Thoughts?

If we like this, I can update the rest of the builders.

[thomastaylor312]

Would it make more sense to swap the parameters of create_collection and execute? Maybe it is just me, but it seems like it makes more sense to have the required params be part of the operation name (e.g. create_collection) and the thing you are actually doing something with be the parameter to execute. Either way, I think this is much cleaner

[MindFlavor]

I agree with @thomastaylor312. I would go further: why separate the parameters in two places? I'd put them all in the create_collection call. Having to specify the mandatory fields in two different places (with no clear understanding of which goes where) is confusing.

Also, from a documentation point of view, I think it would be best to have all the required fields in one place.

[thomastaylor312]

@MindFlavor I disagree with you on that count. That conflates configuration with data. With a builder, you are building up a client that can act on something. That "something" is the document/blob/VM/etc. So it makes sense for it to be separate from my view

[rylev]

@MindFlavor @thomastaylor312 I pushed another commit which switches where the required and the optional arguments are passed.

I also made Offer and IndexingPolicy optional as according to this they are optional. I tried with one of the e2e tests and it seems to work without them.
The only downside of this is that indexing_policy is now an Option on Collection and thus must be unwrapped even tough on response it's never not set.

I needed to make a new type for the the creation collection request body, but this actually cleaned things up.

[thomastaylor312]

Nit: I don't think this needs to be in a separate {} block anymore

[MindFlavor]

count. That conflates configuration with data. With a builder, you are building up a client that can act on something. That "something" is the document/blob/VM/etc. So it makes sense

Yes, you make a valid point 👍 ! I agree

(sorry for taking so long to answer)