Migration to v2 API

[c-seeger]

Due to a recent request about how to migrate to project to v2, we need a proper documentation of how we want to migrate this project from v1 to v2 API.

Requirements:

The following requirements have to be met while migrating:

• backwards compatibility of the current API
• clear distinction between v1 and v2 API calls
• simple way to replace v1 once v2 feature set matches v1

Code Management:

Adding a v2 folder to the project where all code regarding v2 API requests belong to.

To add new code for v2 we will add a v2 version struct to our API and implement v2 API requests as part of the implicit v2 interface.

e.g:

func (a *v2) myNewFunction(MyInput) (MyOutput, error)

This allows us to have distinct calls between v1 (default) and v2 by calling either:

api, err := goconfluence.NewAPI(....)
// handle error

data, err := api.myFunction(input)

// or use v2
data, err := api.v2.myFunction(input)

Migration

Once the feature set of v2 matches v1 we can remove v1 implementation and as well as the v2 API struct and move v2 implementation to the default API implicit interface implementation and release it with a major version release.

[c-seeger]

CC: @coggsflod

[c-seeger]

We also need to add a section to the README describing how to use v2 endpoints, as well as a README for v2 folder containing the current implemented features so it's easy to see when v2 matches the v1 feature set describted in the repo README