Better breaking change notice

[sluongng]

Hey folks,

I appreciate the Golang support but please documentation breaking API changes.

...GetConfig().GetArtDetails undefined (type config.Config has no field or method GetArtDetails)

This was broken upgrading from v0.8.1 -> v0.9.0

This commit broke the API and there were no documentation/announcement for it a265a82

This method is a public API so please dont just change it without announcement :(

[eyalbe4]

@sluongng,
Thanks for sharing this with us.
Till now, we've been treating the APIs documented in the README as public APIs. I believe that the ..GetConfig().GetArtDetails API is not there.
Do you think we should add additional APId to the README, so that they are treated as public? Do you have a suggestion for an alternative way to mark APIs as public? We're open to suggestions.

[sluongng]

https://tour.golang.org/basics/3

Its simple, GetArtDetails() is exported so its open to be used outside of the package. i.e. public usage.
If you dont want to make it public, then just ensure that you dont export the function.

For my use case, I made 2 helper functions in my code

// GetArtUrl is helper method to get base artifactory url from config
func (ctx *ArtServices) GetArtUrl() string {
	return ctx.GetConfig().
		GetArtDetails().
		GetUrl()
}

// GetClientDetails is helper method to get base client config
func (ctx *ArtServices) GetClientDetails() *httputils.HttpClientDetails {
	d := ctx.GetConfig().
		GetArtDetails().
		CreateHttpClientDetails()
	return &d
}

So that I have an easier time building custom request that your client has yet to support.
i.e.

url := ctx.GetArtUrl() + "api/trash/restore/" + blah + "?to=" + blah2

or

myart.Client().SendGet(url, true, ctx.GetClientDetails())

I find that this is a useful flexibility to have while you guys still building more client support for more http api.

[github-actions]

This issue has been marked as stale due to 6 months of inactivity. As part of our effort to address every issue properly, please feel free to remove the stale label or keep this issue active by leaving a comment. Otherwise, it will be closed in 7 days

[github-actions]

This issue was closed due to 7 days of inactivity after being marked as stale. Feel free to reopen it if it remains relevant.