update request API v2 - WriteMode and autorename ?

Antti R.

Based on documentation on API v2 (http) section - it is not clear to me how mode and autorename work together.

Currently WriteMode docs starts with phrase:

"Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is."

Do you actually mean the following: 

"Your intent when writing a file to some path. This is used to determine what constitutes a conflict and what the autorename strategy is (in case autorename - see below - is enabled).

 

 

 

Steve M.

Thanks for the feedback! I think I understand the confusion, and we'll look at how we can reword.

I'd say the documentation is accurate, if a bit confusing to read. I'd also say you understand the semantics correctly.

Think of it like a method taking parameters:

"/files/upload takes a parameter called mode (a WriteMode) and one called autorename (a boolean). The mode parameter determines what constitutes a conflict and a corresponding autorenaming strategy. In the case of a conflict, the autorename parameter determines whether that autorenaming strategy should be employed or the call should simply fail with an error."

So it's true that WriteMode defines an autorename strategy.

None of this takes away from your point that this is ****** to understand from reading the documentation in its current form. I think that's because the documentation sort of mixes parameters, behaviors, and types. The documentation on WriteMode is about that structure/type, so it knows nothing about the autorename parameter, and it wouldn't make sense to mention it there.