TheArchive/tailscale
1
0
Fork 0
mirror of https://github.com/tailscale/tailscale.git synced 2025-06-09 17:28:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

client/tailscale: mark control API client deprecated

Browse Source 
The official client for 3rd party use is at tailscale.com/client/tailscale/v2.

Updates #22748

Signed-off-by: Percy Wegmann <percy@tailscale.com>
This commit is contained in:
Percy Wegmann 2025-02-07 08:54:35 -06:00 committed by Percy Wegmann
parent cbf3852b5d
commit d923979e65
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
client/tailscale/tailscale.go
View File

@ -5,8 +5,10 @@
// Package tailscale contains a Go client for the Tailscale control plane API. // Package tailscale contains a Go client for the Tailscale control plane API.
// //
// Warning: this package is in development and makes no API compatibility // This package is only intended for internal and transitional use.
// promises as of 2022-04-29. It is subject to change at any time. //
// Deprecated: the official control plane client is available at
// tailscale.com/client/tailscale/v2.
package tailscale package tailscale
import ( import (
@ -18,10 +20,7 @@ import (
) )
// I_Acknowledge_This_API_Is_Unstable must be set true to use this package // I_Acknowledge_This_API_Is_Unstable must be set true to use this package
// for now. It was added 2022-04-29 when it was moved to this git repo // for now. This package is being replaced by tailscale.com/client/tailscale/v2.
// and will be removed when the public API has settled.
//
// TODO(bradfitz): remove this after the we're happy with the public API.
var I_Acknowledge_This_API_Is_Unstable = false var I_Acknowledge_This_API_Is_Unstable = false
// TODO: use url.PathEscape() for deviceID and tailnets when constructing requests. // TODO: use url.PathEscape() for deviceID and tailnets when constructing requests.
@ -35,6 +34,8 @@ const maxReadSize = 10 << 20
// //
// Use NewClient to instantiate one. Exported fields should be set before // Use NewClient to instantiate one. Exported fields should be set before
// the client is used and not changed thereafter. // the client is used and not changed thereafter.
//
// Deprecated: use tailscale.com/client/tailscale/v2 instead.
type Client struct { type Client struct {
// tailnet is the globally unique identifier for a Tailscale network, such // tailnet is the globally unique identifier for a Tailscale network, such
// as "example.com" or "user@gmail.com". // as "example.com" or "user@gmail.com".
@ -97,6 +98,8 @@ func (c *Client) setAuth(r *http.Request) {
// If httpClient is nil, then http.DefaultClient is used. // If httpClient is nil, then http.DefaultClient is used.
// "api.tailscale.com" is set as the BaseURL for the returned client // "api.tailscale.com" is set as the BaseURL for the returned client
// and can be changed manually by the user. // and can be changed manually by the user.
//
// Deprecated: use tailscale.com/client/tailscale/v2 instead.
func NewClient(tailnet string, auth AuthMethod) *Client { func NewClient(tailnet string, auth AuthMethod) *Client {
return &Client{ return &Client{
tailnet: tailnet, tailnet: tailnet,