You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@trafficcontrol.apache.org by ma...@apache.org on 2020/08/17 23:16:11 UTC
[trafficcontrol] branch master updated: Move client to versioned
package (#4968)
This is an automated email from the ASF dual-hosted git repository.
mattjackson pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/trafficcontrol.git
The following commit(s) were added to refs/heads/master by this push:
new 75b4f43 Move client to versioned package (#4968)
75b4f43 is described below
commit 75b4f4391ad39a439235a678e65b62754e053462
Author: ocket8888 <oc...@apache.org>
AuthorDate: Mon Aug 17 17:16:01 2020 -0600
Move client to versioned package (#4968)
* Move TO go client to versioned package
* Add deprecation notices
* Updated changelog
---
CHANGELOG.md | 1 +
traffic_ops/README.md | 4 ++++
traffic_ops/client | 1 +
traffic_ops/{client => v3-client}/README.md | 0
traffic_ops/{client => v3-client}/about.go | 9 +++++++--
traffic_ops/{client => v3-client}/api_capability.go | 0
traffic_ops/{client => v3-client}/asn.go | 0
traffic_ops/{client => v3-client}/cachegroup.go | 0
traffic_ops/{client => v3-client}/cachegroup_parameters.go | 0
traffic_ops/{client => v3-client}/capability.go | 0
traffic_ops/{client => v3-client}/cdn.go | 0
traffic_ops/{client => v3-client}/cdn_domains.go | 0
traffic_ops/{client => v3-client}/cdnfederations.go | 0
traffic_ops/{client => v3-client}/coordinate.go | 0
traffic_ops/{client => v3-client}/crconfig.go | 0
traffic_ops/{client => v3-client}/deliveryservice.go | 0
traffic_ops/{client => v3-client}/deliveryservice_regexes.go | 0
.../{client => v3-client}/deliveryservice_request_comments.go | 0
traffic_ops/{client => v3-client}/deliveryservice_requests.go | 0
.../deliveryservices_required_capabilities.go | 0
traffic_ops/{client => v3-client}/deliveryserviceserver.go | 0
traffic_ops/{client => v3-client}/division.go | 0
traffic_ops/{client => v3-client}/dsuser.go | 0
traffic_ops/{client => v3-client}/endpoints.go | 0
traffic_ops/{client => v3-client}/federation.go | 0
.../{client => v3-client}/federation_federation_resolver.go | 0
traffic_ops/{client => v3-client}/federation_resolver.go | 0
traffic_ops/{client => v3-client}/iso.go | 0
traffic_ops/{client => v3-client}/job.go | 0
traffic_ops/{client => v3-client}/log.go | 0
traffic_ops/{client => v3-client}/origin.go | 0
traffic_ops/{client => v3-client}/parameter.go | 0
traffic_ops/{client => v3-client}/phys_location.go | 0
traffic_ops/{client => v3-client}/ping.go | 0
traffic_ops/{client => v3-client}/profile.go | 0
traffic_ops/{client => v3-client}/profile_parameter.go | 0
traffic_ops/{client => v3-client}/region.go | 0
traffic_ops/{client => v3-client}/role.go | 0
traffic_ops/{client => v3-client}/server.go | 0
traffic_ops/{client => v3-client}/server_server_capabilities.go | 0
traffic_ops/{client => v3-client}/server_update_status.go | 0
traffic_ops/{client => v3-client}/servercapability.go | 0
traffic_ops/{client => v3-client}/servercheck.go | 0
traffic_ops/{client => v3-client}/servercheckextensions.go | 0
traffic_ops/{client => v3-client}/serviceCategory.go | 0
traffic_ops/{client => v3-client}/session.go | 0
traffic_ops/{client => v3-client}/staticdnsentry.go | 0
traffic_ops/{client => v3-client}/stats_summary.go | 0
traffic_ops/{client => v3-client}/status.go | 0
traffic_ops/{client => v3-client}/steering.go | 0
traffic_ops/{client => v3-client}/steeringtarget.go | 0
traffic_ops/{client => v3-client}/tenant.go | 0
traffic_ops/{client => v3-client}/topology.go | 0
traffic_ops/{client => v3-client}/traffic_monitor.go | 0
traffic_ops/{client => v3-client}/traffic_stats.go | 0
traffic_ops/{client => v3-client}/type.go | 0
traffic_ops/{client => v3-client}/user.go | 0
traffic_ops/{client => v3-client}/util.go | 0
58 files changed, 13 insertions(+), 2 deletions(-)
diff --git a/CHANGELOG.md b/CHANGELOG.md
index 078a95c..5220b70 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -74,6 +74,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
### Deprecated
- Deprecated the non-nullable `DeliveryService` Go struct and other structs that use it. `DeliveryServiceNullable` structs should be used instead.
+- Importing Traffic Ops Go clients via the un-versioned `github.com/apache/trafficcontrol/traffic_ops/client` is now deprecated in favor of versioned import paths e.g. `github.com/apache/trafficcontrol/traffic_ops/v3-client`.
### Removed
- Removed deprecated Traffic Ops Go Client methods.
diff --git a/traffic_ops/README.md b/traffic_ops/README.md
index 453e218..6a3feeb 100644
--- a/traffic_ops/README.md
+++ b/traffic_ops/README.md
@@ -17,6 +17,10 @@
under the License.
-->
+> :warning: **Importing this client via un-versioned
+`github.com/apache/trafficcontrol/traffic_ops/client` paths is deprecated!** Use
+`github.com/apache/trafficcontrol/traffic_ops/v3-client` (for API v3.0) instead.
+
Traffic Ops is the tool for administration (configuration and monitoring) of all components in a Traffic Control CDN. The CDN administrator uses Traffic Ops to manage servers, cache groups, delivery services, etc. In many cases, a configuration change requires propagation to several, or even all, caches and only explicitly after or before the same change propagates to Traffic Router. Traffic Ops takes care of this required consistency between the different components and their configurat [...]
diff --git a/traffic_ops/client b/traffic_ops/client
new file mode 120000
index 0000000..4d55042
--- /dev/null
+++ b/traffic_ops/client
@@ -0,0 +1 @@
+v3-client
\ No newline at end of file
diff --git a/traffic_ops/client/README.md b/traffic_ops/v3-client/README.md
similarity index 100%
rename from traffic_ops/client/README.md
rename to traffic_ops/v3-client/README.md
diff --git a/traffic_ops/client/about.go b/traffic_ops/v3-client/about.go
similarity index 80%
rename from traffic_ops/client/about.go
rename to traffic_ops/v3-client/about.go
index b1c2d09..c15e74b 100644
--- a/traffic_ops/client/about.go
+++ b/traffic_ops/v3-client/about.go
@@ -1,3 +1,10 @@
+// Package client implements methods for interacting with the Traffic Ops API.
+//
+// Warning: Using the un-versioned import path ("client") is deprecated, and the
+// ability to do so will be removed in ATC 6.0 - please use versioned client
+// imports (e.g. "v3-client") instead
+package client
+
/*
Licensed under the Apache License, Version 2.0 (the "License");
@@ -13,8 +20,6 @@
limitations under the License.
*/
-package client
-
import (
"encoding/json"
"net/http"
diff --git a/traffic_ops/client/api_capability.go b/traffic_ops/v3-client/api_capability.go
similarity index 100%
rename from traffic_ops/client/api_capability.go
rename to traffic_ops/v3-client/api_capability.go
diff --git a/traffic_ops/client/asn.go b/traffic_ops/v3-client/asn.go
similarity index 100%
rename from traffic_ops/client/asn.go
rename to traffic_ops/v3-client/asn.go
diff --git a/traffic_ops/client/cachegroup.go b/traffic_ops/v3-client/cachegroup.go
similarity index 100%
rename from traffic_ops/client/cachegroup.go
rename to traffic_ops/v3-client/cachegroup.go
diff --git a/traffic_ops/client/cachegroup_parameters.go b/traffic_ops/v3-client/cachegroup_parameters.go
similarity index 100%
rename from traffic_ops/client/cachegroup_parameters.go
rename to traffic_ops/v3-client/cachegroup_parameters.go
diff --git a/traffic_ops/client/capability.go b/traffic_ops/v3-client/capability.go
similarity index 100%
rename from traffic_ops/client/capability.go
rename to traffic_ops/v3-client/capability.go
diff --git a/traffic_ops/client/cdn.go b/traffic_ops/v3-client/cdn.go
similarity index 100%
rename from traffic_ops/client/cdn.go
rename to traffic_ops/v3-client/cdn.go
diff --git a/traffic_ops/client/cdn_domains.go b/traffic_ops/v3-client/cdn_domains.go
similarity index 100%
rename from traffic_ops/client/cdn_domains.go
rename to traffic_ops/v3-client/cdn_domains.go
diff --git a/traffic_ops/client/cdnfederations.go b/traffic_ops/v3-client/cdnfederations.go
similarity index 100%
rename from traffic_ops/client/cdnfederations.go
rename to traffic_ops/v3-client/cdnfederations.go
diff --git a/traffic_ops/client/coordinate.go b/traffic_ops/v3-client/coordinate.go
similarity index 100%
rename from traffic_ops/client/coordinate.go
rename to traffic_ops/v3-client/coordinate.go
diff --git a/traffic_ops/client/crconfig.go b/traffic_ops/v3-client/crconfig.go
similarity index 100%
rename from traffic_ops/client/crconfig.go
rename to traffic_ops/v3-client/crconfig.go
diff --git a/traffic_ops/client/deliveryservice.go b/traffic_ops/v3-client/deliveryservice.go
similarity index 100%
rename from traffic_ops/client/deliveryservice.go
rename to traffic_ops/v3-client/deliveryservice.go
diff --git a/traffic_ops/client/deliveryservice_regexes.go b/traffic_ops/v3-client/deliveryservice_regexes.go
similarity index 100%
rename from traffic_ops/client/deliveryservice_regexes.go
rename to traffic_ops/v3-client/deliveryservice_regexes.go
diff --git a/traffic_ops/client/deliveryservice_request_comments.go b/traffic_ops/v3-client/deliveryservice_request_comments.go
similarity index 100%
rename from traffic_ops/client/deliveryservice_request_comments.go
rename to traffic_ops/v3-client/deliveryservice_request_comments.go
diff --git a/traffic_ops/client/deliveryservice_requests.go b/traffic_ops/v3-client/deliveryservice_requests.go
similarity index 100%
rename from traffic_ops/client/deliveryservice_requests.go
rename to traffic_ops/v3-client/deliveryservice_requests.go
diff --git a/traffic_ops/client/deliveryservices_required_capabilities.go b/traffic_ops/v3-client/deliveryservices_required_capabilities.go
similarity index 100%
rename from traffic_ops/client/deliveryservices_required_capabilities.go
rename to traffic_ops/v3-client/deliveryservices_required_capabilities.go
diff --git a/traffic_ops/client/deliveryserviceserver.go b/traffic_ops/v3-client/deliveryserviceserver.go
similarity index 100%
rename from traffic_ops/client/deliveryserviceserver.go
rename to traffic_ops/v3-client/deliveryserviceserver.go
diff --git a/traffic_ops/client/division.go b/traffic_ops/v3-client/division.go
similarity index 100%
rename from traffic_ops/client/division.go
rename to traffic_ops/v3-client/division.go
diff --git a/traffic_ops/client/dsuser.go b/traffic_ops/v3-client/dsuser.go
similarity index 100%
rename from traffic_ops/client/dsuser.go
rename to traffic_ops/v3-client/dsuser.go
diff --git a/traffic_ops/client/endpoints.go b/traffic_ops/v3-client/endpoints.go
similarity index 100%
rename from traffic_ops/client/endpoints.go
rename to traffic_ops/v3-client/endpoints.go
diff --git a/traffic_ops/client/federation.go b/traffic_ops/v3-client/federation.go
similarity index 100%
rename from traffic_ops/client/federation.go
rename to traffic_ops/v3-client/federation.go
diff --git a/traffic_ops/client/federation_federation_resolver.go b/traffic_ops/v3-client/federation_federation_resolver.go
similarity index 100%
rename from traffic_ops/client/federation_federation_resolver.go
rename to traffic_ops/v3-client/federation_federation_resolver.go
diff --git a/traffic_ops/client/federation_resolver.go b/traffic_ops/v3-client/federation_resolver.go
similarity index 100%
rename from traffic_ops/client/federation_resolver.go
rename to traffic_ops/v3-client/federation_resolver.go
diff --git a/traffic_ops/client/iso.go b/traffic_ops/v3-client/iso.go
similarity index 100%
rename from traffic_ops/client/iso.go
rename to traffic_ops/v3-client/iso.go
diff --git a/traffic_ops/client/job.go b/traffic_ops/v3-client/job.go
similarity index 100%
rename from traffic_ops/client/job.go
rename to traffic_ops/v3-client/job.go
diff --git a/traffic_ops/client/log.go b/traffic_ops/v3-client/log.go
similarity index 100%
rename from traffic_ops/client/log.go
rename to traffic_ops/v3-client/log.go
diff --git a/traffic_ops/client/origin.go b/traffic_ops/v3-client/origin.go
similarity index 100%
rename from traffic_ops/client/origin.go
rename to traffic_ops/v3-client/origin.go
diff --git a/traffic_ops/client/parameter.go b/traffic_ops/v3-client/parameter.go
similarity index 100%
rename from traffic_ops/client/parameter.go
rename to traffic_ops/v3-client/parameter.go
diff --git a/traffic_ops/client/phys_location.go b/traffic_ops/v3-client/phys_location.go
similarity index 100%
rename from traffic_ops/client/phys_location.go
rename to traffic_ops/v3-client/phys_location.go
diff --git a/traffic_ops/client/ping.go b/traffic_ops/v3-client/ping.go
similarity index 100%
rename from traffic_ops/client/ping.go
rename to traffic_ops/v3-client/ping.go
diff --git a/traffic_ops/client/profile.go b/traffic_ops/v3-client/profile.go
similarity index 100%
rename from traffic_ops/client/profile.go
rename to traffic_ops/v3-client/profile.go
diff --git a/traffic_ops/client/profile_parameter.go b/traffic_ops/v3-client/profile_parameter.go
similarity index 100%
rename from traffic_ops/client/profile_parameter.go
rename to traffic_ops/v3-client/profile_parameter.go
diff --git a/traffic_ops/client/region.go b/traffic_ops/v3-client/region.go
similarity index 100%
rename from traffic_ops/client/region.go
rename to traffic_ops/v3-client/region.go
diff --git a/traffic_ops/client/role.go b/traffic_ops/v3-client/role.go
similarity index 100%
rename from traffic_ops/client/role.go
rename to traffic_ops/v3-client/role.go
diff --git a/traffic_ops/client/server.go b/traffic_ops/v3-client/server.go
similarity index 100%
rename from traffic_ops/client/server.go
rename to traffic_ops/v3-client/server.go
diff --git a/traffic_ops/client/server_server_capabilities.go b/traffic_ops/v3-client/server_server_capabilities.go
similarity index 100%
rename from traffic_ops/client/server_server_capabilities.go
rename to traffic_ops/v3-client/server_server_capabilities.go
diff --git a/traffic_ops/client/server_update_status.go b/traffic_ops/v3-client/server_update_status.go
similarity index 100%
rename from traffic_ops/client/server_update_status.go
rename to traffic_ops/v3-client/server_update_status.go
diff --git a/traffic_ops/client/servercapability.go b/traffic_ops/v3-client/servercapability.go
similarity index 100%
rename from traffic_ops/client/servercapability.go
rename to traffic_ops/v3-client/servercapability.go
diff --git a/traffic_ops/client/servercheck.go b/traffic_ops/v3-client/servercheck.go
similarity index 100%
rename from traffic_ops/client/servercheck.go
rename to traffic_ops/v3-client/servercheck.go
diff --git a/traffic_ops/client/servercheckextensions.go b/traffic_ops/v3-client/servercheckextensions.go
similarity index 100%
rename from traffic_ops/client/servercheckextensions.go
rename to traffic_ops/v3-client/servercheckextensions.go
diff --git a/traffic_ops/client/serviceCategory.go b/traffic_ops/v3-client/serviceCategory.go
similarity index 100%
rename from traffic_ops/client/serviceCategory.go
rename to traffic_ops/v3-client/serviceCategory.go
diff --git a/traffic_ops/client/session.go b/traffic_ops/v3-client/session.go
similarity index 100%
rename from traffic_ops/client/session.go
rename to traffic_ops/v3-client/session.go
diff --git a/traffic_ops/client/staticdnsentry.go b/traffic_ops/v3-client/staticdnsentry.go
similarity index 100%
rename from traffic_ops/client/staticdnsentry.go
rename to traffic_ops/v3-client/staticdnsentry.go
diff --git a/traffic_ops/client/stats_summary.go b/traffic_ops/v3-client/stats_summary.go
similarity index 100%
rename from traffic_ops/client/stats_summary.go
rename to traffic_ops/v3-client/stats_summary.go
diff --git a/traffic_ops/client/status.go b/traffic_ops/v3-client/status.go
similarity index 100%
rename from traffic_ops/client/status.go
rename to traffic_ops/v3-client/status.go
diff --git a/traffic_ops/client/steering.go b/traffic_ops/v3-client/steering.go
similarity index 100%
rename from traffic_ops/client/steering.go
rename to traffic_ops/v3-client/steering.go
diff --git a/traffic_ops/client/steeringtarget.go b/traffic_ops/v3-client/steeringtarget.go
similarity index 100%
rename from traffic_ops/client/steeringtarget.go
rename to traffic_ops/v3-client/steeringtarget.go
diff --git a/traffic_ops/client/tenant.go b/traffic_ops/v3-client/tenant.go
similarity index 100%
rename from traffic_ops/client/tenant.go
rename to traffic_ops/v3-client/tenant.go
diff --git a/traffic_ops/client/topology.go b/traffic_ops/v3-client/topology.go
similarity index 100%
rename from traffic_ops/client/topology.go
rename to traffic_ops/v3-client/topology.go
diff --git a/traffic_ops/client/traffic_monitor.go b/traffic_ops/v3-client/traffic_monitor.go
similarity index 100%
rename from traffic_ops/client/traffic_monitor.go
rename to traffic_ops/v3-client/traffic_monitor.go
diff --git a/traffic_ops/client/traffic_stats.go b/traffic_ops/v3-client/traffic_stats.go
similarity index 100%
rename from traffic_ops/client/traffic_stats.go
rename to traffic_ops/v3-client/traffic_stats.go
diff --git a/traffic_ops/client/type.go b/traffic_ops/v3-client/type.go
similarity index 100%
rename from traffic_ops/client/type.go
rename to traffic_ops/v3-client/type.go
diff --git a/traffic_ops/client/user.go b/traffic_ops/v3-client/user.go
similarity index 100%
rename from traffic_ops/client/user.go
rename to traffic_ops/v3-client/user.go
diff --git a/traffic_ops/client/util.go b/traffic_ops/v3-client/util.go
similarity index 100%
rename from traffic_ops/client/util.go
rename to traffic_ops/v3-client/util.go