Implement documents.create

[zadjadr]

Implements https://www.getoutline.com/developers#tag/Documents/paths/~1documents.create/post and improves the pipeline

Related: #5

[StefMa]

Didn't had a look at the code, but only about the CI improvement.

Did you saw #18?

[zadjadr]

I implemented documents.update and attachments.create as well & will create the PR, if this one is approved and merged

zadjadr#1
zadjadr#2

[StefMa]

Code looks good so far 👌 Didn't tested it but should work 😉
Just a few nitpitting questions/comments.

Thanks for the efford and the contribution 👍

[StefMa]

Do we already want to go with such a complicated strucutre?
We need it earlier or later anyways, but so far we just went with the basics create collection(name), that's it.
Just wanted to questions this, no changes requested.

Also, is it common to have so many parameters in go (in a single line)? 🤔
If is so, I like the Kotlin code style to have each param in its own line:

func (cl *DocumentsClient) Create(
    collectionID CollectionID, 
    title string,
    text string,
    ....,

But I have no strong opinion on that and don't know whats "the way" to go.
@rsjethani ? 🙂

[zadjadr]

Do we already want to go with such a complicated strucutre?

• We (Sre) have a ticket, which needs us to be able to create a document with these features (only template + templateID where added as an extra, since it would be half implemented anyways)

Multiline parameters:
No Idea, I'd also be in favor of the kotlin way :)
We could probably go with any of these: https://realm.github.io/SwiftLint/multiline_parameters.html

[ioki-cha]

In Go, there is no discussion. gofmt and you take that. :)

Regarding the signature: It's pretty long indeed, maybe you can set some sensible defaults and override those with something like func (cl *DocumentsClient) SetTemplateId(TemplateID)?

[rsjethani]

@zadjadr
Multi-line parameters are usually not preferred, they are usually a code smell hinting that code restructuring can reduce number of parameters required. A very straight forward approach is to only ask for mandatory parameters. In this case you should take only title and collection id as compulsory values. For optional values you can have option methods which configure optional behavior. BTW you cannot have create method on DocumentsClient, you need a new type DocumentsClientCreate to maintain consistency across api usage. Following is how the API call can look like eventually:

client.Documents().Create(title, collection id).Text("doc text").Do(...)

Observe: Text is an example of a option method which allows configuring optional behavior. If we do not want to set text for the document then that call can be omitted.

[StefMa]

Yep, looks good to me 👍
Nice work. 🚀

[StefMa]

@rsjethani please have a final look at this 🙏

[zadjadr]

I resolved the conflicts with upstream/main

[StefMa]

Just two smaller comments.
However, I wil going to merge this as we should finally get things done.
Improvements can be still done later 👍
I will create a follow-up issues for those things to be evaluated.

[StefMa]

Not sure if if we need this as an extra type..
Maybe DocumentId is enough, but naming it parentDocumentId 🤷

[StefMa]

We could already create a User model 🤷