[trafficcontrol] branch master updated: Fix docs for api_capabilities endpoint (#6256)

[oc...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ocket8888 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 f93981b  Fix docs for api_capabilities endpoint (#6256)
f93981b is described below

commit f93981b93bb5021906a1f2ec5177865fca08f176
Author: Srijeet Chatterjee <30...@users.noreply.github.com>
AuthorDate: Thu Oct 7 19:15:15 2021 -0600

    Fix docs for api_capabilities endpoint (#6256)
---
 docs/source/api/v2/api_capabilities.rst                          | 2 +-
 docs/source/api/v3/api_capabilities.rst                          | 2 +-
 traffic_ops/traffic_ops_golang/apicapability/api_capabilities.go | 1 +
 3 files changed, 3 insertions(+), 2 deletions(-)

diff --git a/docs/source/api/v2/api_capabilities.rst b/docs/source/api/v2/api_capabilities.rst
index 02835d8..dd67723 100644
--- a/docs/source/api/v2/api_capabilities.rst
+++ b/docs/source/api/v2/api_capabilities.rst
@@ -18,7 +18,7 @@
 ********************
 ``api_capabilities``
 ********************
-.. deprecated:: ATCv7.0
+.. deprecated:: 3.1
 
 Deals with the capabilities that may be associated with API endpoints and methods. These capabilities are assigned to :term:`Roles`, of which a user may have one or more. Capabilities support "wildcarding" or "globbing" using asterisks to group multiple routes into a single capability
 
diff --git a/docs/source/api/v3/api_capabilities.rst b/docs/source/api/v3/api_capabilities.rst
index d135730..8d9f70a 100644
--- a/docs/source/api/v3/api_capabilities.rst
+++ b/docs/source/api/v3/api_capabilities.rst
@@ -18,7 +18,7 @@
 ********************
 ``api_capabilities``
 ********************
-.. deprecated:: ATCv7.0
+.. deprecated:: 3.1
 
 Deals with the capabilities that may be associated with API endpoints and methods. These capabilities are assigned to :term:`Roles`, of which a user may have one or more. Capabilities support "wildcarding" or "globbing" using asterisks to group multiple routes into a single capability
 
diff --git a/traffic_ops/traffic_ops_golang/apicapability/api_capabilities.go b/traffic_ops/traffic_ops_golang/apicapability/api_capabilities.go
index 32fe164..74ec074 100644
--- a/traffic_ops/traffic_ops_golang/apicapability/api_capabilities.go
+++ b/traffic_ops/traffic_ops_golang/apicapability/api_capabilities.go
@@ -39,6 +39,7 @@ import (
 // GetAPICapabilitiesHandler implements an http handler that returns
 // API Capabilities. In the event a capability parameter is supplied,
 // it will return only those with an exact match.
+// Deprecated: This API endpoint is deprecated, and will be removed in api v4 and above.
 func GetAPICapabilitiesHandler(w http.ResponseWriter, r *http.Request) {
 	inf, userErr, sysErr, errCode := api.NewInfo(r, nil, nil)
 	if userErr != nil || sysErr != nil {