Skip to content

Commit

Permalink
Walk back deprecation of TO APIv3, add instability warnings for 4.0 (#…
Browse files Browse the repository at this point in the history
…6209)

* Walk back deprecation of TO APIv3, add instability warnings for 4.0

* Update client READMEs
  • Loading branch information
ocket8888 authored Sep 15, 2021
1 parent cf10d69 commit 7d67421
Show file tree
Hide file tree
Showing 5 changed files with 14 additions and 15 deletions.
4 changes: 2 additions & 2 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- Added ORT flag to set local.dns bind address from server service addresses
- Added an endpoint for statuses on asynchronous jobs and applied it to the ACME renewal endpoint.
- Added two new cdn.conf options to make Traffic Vault configuration more backend-agnostic: `traffic_vault_backend` and `traffic_vault_config`
- Traffic Ops API version 4.0
- Traffic Ops API version 4.0 - This version is **unstable** meaning that breaking changes can occur at any time - use at your own peril!
- `GET` request method for `/deliveryservices/{{ID}}/assign`
- `GET` request method for `/deliveryservices/{{ID}}/status`
- [#5644](https://github.com/apache/trafficcontrol/issues/5644) ORT config generation: Added ATS9 ip_allow.yaml support, and automatic generation if the server's package Parameter is 9.\*
Expand Down Expand Up @@ -151,7 +151,7 @@ The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/).
- The Traffic Ops API routes `GET /api/{version}/cachegroupparameters`, `POST /api/{version}/cachegroupparameters`, `GET /api/{version}/cachegroups/{id}/parameters`, and `DELETE /api/{version}/cachegroupparameters/{cachegroupID}/{parameterId}` have been deprecated and will no longer be available as of Traffic Ops API v4
- The `riak_port` option in cdn.conf is now deprecated. Please use the `"port"` field in `traffic_vault_config` instead.
- The `traffic_ops_ort.pl` tool has been deprecated in favor of `t3c`, and will be removed in the next major version.
- With the release of Traffic Ops API version 4.0, major API versions 2 and 3 are now deprecated, subject to removal with the next ATC major version release, at the earliest.
- With the release of ATC v6.0, major API version 2 is now deprecated, subject to removal with the next ATC major version release, at the earliest.

### Removed
- Removed the unused `backend_max_connections` option from `cdn.conf`.
Expand Down
7 changes: 3 additions & 4 deletions docs/source/api/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -309,7 +309,7 @@ API V2 Routes
API routes available in version 2.

.. deprecated:: ATCv6
Traffic Ops API version 2 is deprecated in favor of version 4.
Traffic Ops API version 2 is deprecated in favor of version 3.

.. toctree::
:maxdepth: 4
Expand All @@ -321,9 +321,6 @@ API V3 Routes
=============
API routes available in version 3.

.. deprecated:: ATCv6
Traffic Ops API version 3 is deprecated in favor of version 4.

.. toctree::
:maxdepth: 4
:glob:
Expand All @@ -334,6 +331,8 @@ API V4 Routes
=============
API routes available in version 4.

.. danger:: API version 4 is *unstable*, meaning that breaking changes can occur at any time. Use at your own peril!

.. toctree::
:maxdepth: 4
:glob:
Expand Down
4 changes: 2 additions & 2 deletions traffic_ops/v2-client/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,13 @@

## Deprecated
The version of the Traffic Ops API supported by this client is deprecated.
Please switch to the `github.com/apache/trafficcontrol/traffic_ops/v4-client`
Please switch to the `github.com/apache/trafficcontrol/traffic_ops/v3-client`
package.

## Getting Started
1. Obtain the latest version of the library

`go get github.com/apache/trafficcontrol/traffic_ops/client`
`go get github.com/apache/trafficcontrol/traffic_ops/v2-client`

2. Get a basic TO session started and fetch a list of CDNs
```go
Expand Down
7 changes: 1 addition & 6 deletions traffic_ops/v3-client/README.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,9 @@
# Traffic Ops Go Client

## Deprecated
The version of the Traffic Ops API supported by this client is deprecated.
Please switch to the `github.com/apache/trafficcontrol/traffic_ops/v4-client`
package.

## Getting Started
1. Obtain the latest version of the library

`go get github.com/apache/trafficcontrol/traffic_ops/client`
`go get github.com/apache/trafficcontrol/traffic_ops/v3-client`

2. Get a basic TO session started and fetch a list of CDNs
```go
Expand Down
7 changes: 6 additions & 1 deletion traffic_ops/v4-client/README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,14 @@
# Traffic Ops Go Client

## Unstable
The version of the Traffic Ops API for which this client was made is
*unstable*, meaning that breaking changes to it - and to this client - can
occur at any time. Use at your own peril!

## Getting Started
1. Obtain the latest version of the library

`go get github.com/apache/trafficcontrol/traffic_ops/client`
`go get github.com/apache/trafficcontrol/traffic_ops/v4-client`

2. Get a basic TO session started and fetch a list of CDNs
```go
Expand Down

0 comments on commit 7d67421

Please sign in to comment.