You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@trafficcontrol.apache.org by GitBox <gi...@apache.org> on 2020/03/06 18:09:44 UTC
[GitHub] [trafficcontrol] shamrickus opened a new pull request #4470:
Deprecate keys/ping
shamrickus opened a new pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470
<!--
************ STOP!! ************
If this Pull Request is intended to fix a security vulnerability, DO NOT submit it! Instead, contact
the Apache Software Foundation Security Team at security@trafficcontrol.apache.org and follow the
guidelines at https://www.apache.org/security/ regarding vulnerability disclosure.
-->
## What does this PR (Pull Request) do?
<!-- Explain the changes you made here. If this fixes an Issue, identify it by
replacing the text in the checkbox item with the Issue number e.g.
- [x] This PR fixes #9001 OR is not related to any Issue
^ This will automatically close Issue number 9001 when the Pull Request is
merged (The '#' is important).
Be sure you check the box properly, see the "The following criteria are ALL
met by this PR" section for details.
-->
- [x] This PR deprecates keys/ping with no alternative
## Which Traffic Control components are affected by this PR?
<!-- Please delete all components from this list that are NOT affected by this
Pull Request. Also, feel free to add the name of a tool or script that is
affected but not on the list.
Additionally, if this Pull Request does NOT affect documentation, please
explain why documentation is not required. -->
- Documentation
- Traffic Ops
## What is the best way to verify this PR?
Build the docs and TO. Verify tests pass and that 2.0 route doesn't exist while 1.x route returns a deprecation warning
<!-- Please include here ALL the steps necessary to test your Pull Request. If
it includes tests (and most should), outline here the steps needed to run the
tests. If not, lay out the manual testing procedure and please explain why
tests are unnecessary for this Pull Request. -->
<!-- If this PR fixes a bug, please list here all of the affected versions - to
the best of your knowledge. It's also pretty helpful to include a commit hash
of where 'master' is at the time this PR is opened (if it affects master),
because what 'master' means will change over time. For example, if this PR
fixes a bug that's present in master (at commit hash '2697ebac'), in v3.0.0,
and in the current 3.0.1 Release candidate (e.g. RC1), then this list would
look like:
- master (2697ebac)
- 3.0.0
- 3.0.1 (RC1)
If you don't know what other versions might have this bug, AND don't know how
to find the commit hash of 'master', then feel free to leave this section
blank (or, preferably, delete it entirely).
-->
## The following criteria are ALL met by this PR
<!-- Check the boxes to signify that the associated statement is true. To
"check a box", replace the space inside of the square brackets with an 'x'.
e.g.
- [ x] <- Wrong
- [x ] <- Wrong
- [] <- Wrong
- [*] <- Wrong
- [x] <- Correct!
-->
- [x] This PR includes tests OR I have explained why tests are unnecessary
- [x] This PR includes documentation OR I have explained why documentation is unnecessary
- [x] This PR includes an update to CHANGELOG.md OR such an update is not necessary
- [x] This PR includes any and all required license headers
- [x] This PR ensures that database migration sequence is correct OR this PR does not include a database migration
- [x] This PR **DOES NOT FIX A SERIOUS SECURITY VULNERABILITY** (see [the Apache Software Foundation's security guidelines](https://www.apache.org/security/) for details)
## Additional Information
<!-- If you would like to include any additional information on the PR for
potential reviewers please put it here.
Some examples of this would be:
- Before and after screenshots/gifs of the Traffic Portal if it is affected
- Links to other dependent Pull Requests
- References to relevant context (e.g. new/updates to dependent libraries,
mailing list records, blueprints)
Feel free to leave this section blank (or, preferably, delete it entirely).
-->
<!--
Licensed to the Apache Software Foundation (ASF) under one
or more contributor license agreements. See the NOTICE file
distributed with this work for additional information
regarding copyright ownership. The ASF licenses this file
to you under the Apache License, Version 2.0 (the
"License"); you may not use this file except in compliance
with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing,
software distributed under the License is distributed on an
"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
KIND, either express or implied. See the License for the
specific language governing permissions and limitations
under the License.
-->
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mattjackson220 commented on a change in pull
request #4470: Deprecate keys/ping
Posted by GitBox <gi...@apache.org>.
mattjackson220 commented on a change in pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470#discussion_r390515085
##########
File path: traffic_ops/traffic_ops_golang/ping/keys.go
##########
@@ -20,25 +20,29 @@ package ping
*/
import (
- "errors"
+ "github.com/apache/trafficcontrol/lib/go-tc"
"net/http"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/api"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/riaksvc"
)
func Keys(w http.ResponseWriter, r *http.Request) {
+ alerts := tc.CreateAlerts(tc.WarnLevel, "This endpoint is deprecated")
inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil)
if userErr != nil || sysErr != nil {
- api.HandleErr(w, r, inf.Tx.Tx, errCode, userErr, sysErr)
+ userErr = api.LogErr(r, errCode, userErr, sysErr)
+ alerts.AddAlerts(tc.CreateErrorAlerts(userErr))
+ api.WriteAlerts(w, r, errCode, alerts)
Review comment:
so i added a HandleDeprecatedErr function in PR 4452 that will hopefully be merged in soon but id use that generic handler instead. i can see about getting it reviewed / merged otherwise you can just steal that code
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] shamrickus commented on a change in pull request
#4470: Deprecate keys/ping
Posted by GitBox <gi...@apache.org>.
shamrickus commented on a change in pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470#discussion_r390968039
##########
File path: docs/source/api/v1/keys_ping.rst
##########
@@ -0,0 +1,69 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+.. _to-api-keys-ping:
+
+*************
+``keys/ping``
+*************
+Checks whether :ref:`tv-overview` is online.
+
+.. deprecated:: ATCv4
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type: Object
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/1.1/keys/ping HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:server: The hostname and port of :ref:`tv-overview`.
+:status: The `reaspon phrase <https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1>`_ of the response that :ref:`to-overview` received from :ref:`tv-overview`.
+
+.. code-block:: http
+ :caption: Response Example
+
+ HTTP/1.1 200 OK
+ Access-Control-Allow-Credentials: true
+ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
+ Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ Access-Control-Allow-Origin: *
+ Content-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:09:31 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: Y/Br43Y5SXXBIneAgHANBXDP0hqO4Lkguk0vmuTU7xktZq3EldK5SX9OkEm9gzRkPKjQVUy0hhldsq6Ax46k7A==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:09:31 GMT
+ Content-Length: 87
+
+ { "alerts": [{
+ "level": "warning",
+ "text": "This endpoint is deprecated."
+ }]
Review comment:
Good catch, didn't mean to remove that
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mattjackson220 commented on a change in pull
request #4470: Deprecate keys/ping
Posted by GitBox <gi...@apache.org>.
mattjackson220 commented on a change in pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470#discussion_r390515343
##########
File path: traffic_ops/traffic_ops_golang/ping/keys.go
##########
@@ -20,25 +20,29 @@ package ping
*/
import (
- "errors"
+ "github.com/apache/trafficcontrol/lib/go-tc"
"net/http"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/api"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/riaksvc"
)
func Keys(w http.ResponseWriter, r *http.Request) {
+ alerts := tc.CreateAlerts(tc.WarnLevel, "This endpoint is deprecated")
inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil)
if userErr != nil || sysErr != nil {
- api.HandleErr(w, r, inf.Tx.Tx, errCode, userErr, sysErr)
+ userErr = api.LogErr(r, errCode, userErr, sysErr)
+ alerts.AddAlerts(tc.CreateErrorAlerts(userErr))
+ api.WriteAlerts(w, r, errCode, alerts)
return
}
defer inf.Close()
pingResp, err := riaksvc.Ping(inf.Tx.Tx, inf.Config.RiakAuthOptions, inf.Config.RiakPort)
if err != nil {
- api.HandleErr(w, r, inf.Tx.Tx, http.StatusInternalServerError, nil, errors.New("error pinging Riak keys: "+err.Error()))
+ alerts.AddAlerts(tc.CreateErrorAlerts(userErr))
+ api.WriteAlerts(w, r, http.StatusInternalServerError, alerts)
Review comment:
same here regarding HandleDeprecatedErr
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mattjackson220 commented on a change in pull
request #4470: Deprecate keys/ping
Posted by GitBox <gi...@apache.org>.
mattjackson220 commented on a change in pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470#discussion_r390511495
##########
File path: traffic_ops/traffic_ops_golang/ping/keys.go
##########
@@ -20,25 +20,29 @@ package ping
*/
import (
- "errors"
+ "github.com/apache/trafficcontrol/lib/go-tc"
"net/http"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/api"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/riaksvc"
)
func Keys(w http.ResponseWriter, r *http.Request) {
+ alerts := tc.CreateAlerts(tc.WarnLevel, "This endpoint is deprecated")
Review comment:
since this is being deprecated because the `/riak/ping` endpoint did the same what do you think about putting in an alternative for this like we did when we moved that one? `"text": "This endpoint is deprecated, please use GET /api/2.0/vault/ping instead"`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mattjackson220 commented on a change in pull
request #4470: Deprecate keys/ping
Posted by GitBox <gi...@apache.org>.
mattjackson220 commented on a change in pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470#discussion_r390999168
##########
File path: docs/source/api/v1/keys_ping.rst
##########
@@ -0,0 +1,73 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+.. _to-api-keys-ping:
+
+*************
+``keys/ping``
+*************
+Checks whether :ref:`tv-overview` is online.
+
+.. deprecated:: ATCv4
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type: Object
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/1.1/keys/ping HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:server: The hostname and port of :ref:`tv-overview`.
+:status: The `reason phrase <https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1>`_ of the response that :ref:`to-overview` received from :ref:`tv-overview`.
+
+.. code-block:: http
+ :caption: Response Example
+
+ HTTP/1.1 200 OK
+ Access-Control-Allow-Credentials: true
+ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
+ Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ Access-Control-Allow-Origin: *
+ Content-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:09:31 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: Y/Br43Y5SXXBIneAgHANBXDP0hqO4Lkguk0vmuTU7xktZq3EldK5SX9OkEm9gzRkPKjQVUy0hhldsq6Ax46k7A==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:09:31 GMT
+ Content-Length: 139
+
+ { "alerts": [{
+ "level": "warning",
+ "text": "This endpoint is deprecated."
Review comment:
please update to have the new alternative option
`This endpoint is deprecated, please use /vault/ping instead`
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mattjackson220 commented on a change in pull
request #4470: Deprecate keys/ping
Posted by GitBox <gi...@apache.org>.
mattjackson220 commented on a change in pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470#discussion_r390510637
##########
File path: traffic_ops/traffic_ops_golang/ping/keys.go
##########
@@ -20,25 +20,29 @@ package ping
*/
import (
- "errors"
+ "github.com/apache/trafficcontrol/lib/go-tc"
Review comment:
super nit but we try to put all of the github imports together
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mattjackson220 commented on a change in pull
request #4470: Deprecate keys/ping
Posted by GitBox <gi...@apache.org>.
mattjackson220 commented on a change in pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470#discussion_r390509284
##########
File path: docs/source/api/v1/keys_ping.rst
##########
@@ -0,0 +1,69 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+.. _to-api-keys-ping:
+
+*************
+``keys/ping``
+*************
+Checks whether :ref:`tv-overview` is online.
+
+.. deprecated:: ATCv4
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type: Object
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/1.1/keys/ping HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:server: The hostname and port of :ref:`tv-overview`.
+:status: The `reaspon phrase <https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1>`_ of the response that :ref:`to-overview` received from :ref:`tv-overview`.
Review comment:
typo - should be "reason"
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mattjackson220 commented on a change in pull
request #4470: Deprecate keys/ping
Posted by GitBox <gi...@apache.org>.
mattjackson220 commented on a change in pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470#discussion_r390510123
##########
File path: docs/source/api/v1/keys_ping.rst
##########
@@ -0,0 +1,69 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+.. _to-api-keys-ping:
+
+*************
+``keys/ping``
+*************
+Checks whether :ref:`tv-overview` is online.
+
+.. deprecated:: ATCv4
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type: Object
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/1.1/keys/ping HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:server: The hostname and port of :ref:`tv-overview`.
+:status: The `reaspon phrase <https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1>`_ of the response that :ref:`to-overview` received from :ref:`tv-overview`.
+
+.. code-block:: http
+ :caption: Response Example
+
+ HTTP/1.1 200 OK
+ Access-Control-Allow-Credentials: true
+ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
+ Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ Access-Control-Allow-Origin: *
+ Content-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:09:31 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: Y/Br43Y5SXXBIneAgHANBXDP0hqO4Lkguk0vmuTU7xktZq3EldK5SX9OkEm9gzRkPKjQVUy0hhldsq6Ax46k7A==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:09:31 GMT
+ Content-Length: 87
+
+ { "alerts": [{
+ "level": "warning",
+ "text": "This endpoint is deprecated."
+ }]
Review comment:
there should be more to the response right? like this:
{
"alerts": [
{
"text": "This endpoint is deprecated",
"level": "warning"
}
],
"response": {
"status": "OK",
"server": "trafficvault.infra.ciab.test:8087"
}
}
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mattjackson220 merged pull request #4470:
Deprecate keys/ping
Posted by GitBox <gi...@apache.org>.
mattjackson220 merged pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mattjackson220 commented on a change in pull
request #4470: Deprecate keys/ping
Posted by GitBox <gi...@apache.org>.
mattjackson220 commented on a change in pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470#discussion_r390512202
##########
File path: traffic_ops/traffic_ops_golang/ping/keys.go
##########
@@ -20,25 +20,29 @@ package ping
*/
import (
- "errors"
+ "github.com/apache/trafficcontrol/lib/go-tc"
"net/http"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/api"
"github.com/apache/trafficcontrol/traffic_ops/traffic_ops_golang/riaksvc"
)
func Keys(w http.ResponseWriter, r *http.Request) {
+ alerts := tc.CreateAlerts(tc.WarnLevel, "This endpoint is deprecated")
Review comment:
you should be able to use the CreateDeprecationAlerts function in api.go to keep that deprecation message consistent
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services
[GitHub] [trafficcontrol] mattjackson220 commented on a change in pull
request #4470: Deprecate keys/ping
Posted by GitBox <gi...@apache.org>.
mattjackson220 commented on a change in pull request #4470: Deprecate keys/ping
URL: https://github.com/apache/trafficcontrol/pull/4470#discussion_r390510123
##########
File path: docs/source/api/v1/keys_ping.rst
##########
@@ -0,0 +1,69 @@
+..
+..
+.. Licensed under the Apache License, Version 2.0 (the "License");
+.. you may not use this file except in compliance with the License.
+.. You may obtain a copy of the License at
+..
+.. http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS,
+.. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+.. See the License for the specific language governing permissions and
+.. limitations under the License.
+..
+.. _to-api-keys-ping:
+
+*************
+``keys/ping``
+*************
+Checks whether :ref:`tv-overview` is online.
+
+.. deprecated:: ATCv4
+
+``GET``
+=======
+:Auth. Required: Yes
+:Roles Required: None
+:Response Type: Object
+
+Request Structure
+-----------------
+No parameters available.
+
+.. code-block:: http
+ :caption: Request Example
+
+ GET /api/1.1/keys/ping HTTP/1.1
+ User-Agent: python-requests/2.22.0
+ Accept-Encoding: gzip, deflate
+ Accept: */*
+ Connection: keep-alive
+ Cookie: mojolicious=...
+
+Response Structure
+------------------
+:server: The hostname and port of :ref:`tv-overview`.
+:status: The `reaspon phrase <https://www.w3.org/Protocols/rfc2616/rfc2616-sec6.html#sec6.1.1>`_ of the response that :ref:`to-overview` received from :ref:`tv-overview`.
+
+.. code-block:: http
+ :caption: Response Example
+
+ HTTP/1.1 200 OK
+ Access-Control-Allow-Credentials: true
+ Access-Control-Allow-Headers: Origin, X-Requested-With, Content-Type, Accept, Set-Cookie, Cookie
+ Access-Control-Allow-Methods: POST,GET,OPTIONS,PUT,DELETE
+ Access-Control-Allow-Origin: *
+ Content-Encoding: gzip
+ Content-Type: application/json
+ Set-Cookie: mojolicious=...; Path=/; Expires=Mon, 24 Feb 2020 21:09:31 GMT; Max-Age=3600; HttpOnly
+ Whole-Content-Sha512: Y/Br43Y5SXXBIneAgHANBXDP0hqO4Lkguk0vmuTU7xktZq3EldK5SX9OkEm9gzRkPKjQVUy0hhldsq6Ax46k7A==
+ X-Server-Name: traffic_ops_golang/
+ Date: Mon, 24 Feb 2020 20:09:31 GMT
+ Content-Length: 87
+
+ { "alerts": [{
+ "level": "warning",
+ "text": "This endpoint is deprecated."
+ }]
Review comment:
there should be more to the response right? like this:
```
{
"alerts": [
{
"text": "This endpoint is deprecated",
"level": "warning"
}
],
"response": {
"status": "OK",
"server": "trafficvault.infra.ciab.test:8087"
}
}
```
----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
With regards,
Apache Git Services