[GitHub] [trafficcontrol] ocket8888 commented on a change in pull request #6145: Create v5 TO API

[GitBox <gi...@apache.org>]

ocket8888 commented on a change in pull request #6145:
URL: https://github.com/apache/trafficcontrol/pull/6145#discussion_r697043830



##########
File path: .github/workflows/traffic-ops.yml
##########
@@ -163,3 +163,24 @@ jobs:
         path: ${{ github.workspace }}/traffic_ops/traffic_ops_golang/traffic.ops.log
     - name: Save Alpine Docker image
       run: .github/actions/save-alpine-tar/entrypoint.sh save ${{ env.ALPINE_VERSION }}
+    - name: Run API v5 tests
+      id: v5Tests
+      if: ${{ steps.todb.outcome == 'success' && always() }}
+      uses: ./.github/actions/to-integration-tests
+      with:
+        version: 4

Review comment:
       version should be 5

##########
File path: docs/source/api/v5/acme_accounts.rst
##########
@@ -0,0 +1,199 @@
+..
+..
+.. 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-acme-accounts:

Review comment:
       duplicate label - the v4 docs should specify `-v4` in their labels. That way links from outside the API docs themselves are updated to latest automatically

##########
File path: docs/source/api/index.rst
##########
@@ -342,3 +342,16 @@ API routes available in version 4.
 
 
 .. [1] A cookie obtained by logging in through Traffic Portal can be used to access API endpoints under the Traffic Portal domain name - since it will proxy such requests back to Traffic Ops. This is not recommended in actual deployments, however, because it will involve an extra network connection which could be avoided by simply using the Traffic Ops domain itself.
+
+API V5 Routes
+=============
+API routes available in version 5.
+
+.. toctree::
+	:maxdepth: 4
+	:glob:
+
+	v5/*
+
+
+.. [1] A cookie obtained by logging in through Traffic Portal can be used to access API endpoints under the Traffic Portal domain name - since it will proxy such requests back to Traffic Ops. This is not recommended in actual deployments, however, because it will involve an extra network connection which could be avoided by simply using the Traffic Ops domain itself.

Review comment:
       duplicated footnote

##########
File path: docs/source/api/v5/about.rst
##########
@@ -0,0 +1,79 @@
+..
+..
+.. 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-v5-about:

Review comment:
       latest versions shouldn't use a `-v5` in the names




-- 
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.

To unsubscribe, e-mail: issues-unsubscribe@trafficcontrol.apache.org

For queries about this service, please contact Infrastructure at:
users@infra.apache.org