61d084593c
The 'Deprecated:' line in NewClient's doc comment was not in a new
paragraph, so GoDoc, linters, and IDEs were unaware that it was
deprecated. The package documentation also continued to reference
NewClient. Update the doc comments to finish documenting that NewClient
is deprecated.
Signed-off-by: Cory Snider <csnider@mirantis.com>
(cherry picked from commit 6b9968e8b1)
Signed-off-by: Sebastiaan van Stijn <github@gone.nl>
27 lines
1.2 KiB
Go
27 lines
1.2 KiB
Go
package client
|
|
|
|
import "net/http"
|
|
|
|
// NewClient initializes a new API client for the given host and API version.
|
|
// It uses the given http client as transport.
|
|
// It also initializes the custom http headers to add to each request.
|
|
//
|
|
// It won't send any version information if the version number is empty. It is
|
|
// highly recommended that you set a version or your client may break if the
|
|
// server is upgraded.
|
|
//
|
|
// Deprecated: use [NewClientWithOpts] passing the [WithHost], [WithVersion],
|
|
// [WithHTTPClient] and [WithHTTPHeaders] options. We recommend enabling API
|
|
// version negotiation by passing the [WithAPIVersionNegotiation] option instead
|
|
// of WithVersion.
|
|
func NewClient(host string, version string, client *http.Client, httpHeaders map[string]string) (*Client, error) {
|
|
return NewClientWithOpts(WithHost(host), WithVersion(version), WithHTTPClient(client), WithHTTPHeaders(httpHeaders))
|
|
}
|
|
|
|
// NewEnvClient initializes a new API client based on environment variables.
|
|
// See FromEnv for a list of support environment variables.
|
|
//
|
|
// Deprecated: use [NewClientWithOpts] passing the [FromEnv] option.
|
|
func NewEnvClient() (*Client, error) {
|
|
return NewClientWithOpts(FromEnv)
|
|
}
|