Merge pull request #1507 from VWS-Python/redirect-link

Update link references given vuforia docs changes

Author: adamtheturtle

docs/source/ci-setup.rst

@@ -11,9 +11,6 @@ To avoid hitting request quotas and to avoid conflicts when running multiple tes
 
 CI builds use a different credentials file depending on the build configuration.
 Within a workflow, this avoids conflicts.
-However, there may be conflicts across workflows, as currently there is no way to prevent workflows from running in parallel.
-See https://github.community/t5/GitHub-Actions/Prevent-parallel-workflows/td-p/32889.
-
 
 How to set GitHub Actions secrets
 ---------------------------------

docs/source/contributing.rst

@@ -143,13 +143,13 @@ The database summary from ``GET /summary`` has multiple undocumented return fiel
 
 The database summary from ``GET /summary`` is not immediately accurate.
 
-The documentation page `How To Perform an Image Recognition Query`_ states that the ``Content-Type`` header must be set to ``multipart/form-data``.
+The documentation page `Vuforia Query Web API`_ states that the ``Content-Type`` header must be set to ``multipart/form-data``.
 However, it must be set to ``multipart/form-data; boundary=<BOUNDARY>`` where ``<BOUNDARY>`` is the boundary used when encoding the form data.
 
-The documentation page `How To Perform an Image Recognition Query`_ states that ``Content-Type`` will be the only response header.
+The documentation page `Vuforia Query Web API`_ states that ``Content-Type`` will be the only response header.
 This is not the case.
 
-The documentation page `How To Perform an Image Recognition Query`_ states that 10 is the maximum allowed value of ``max_num_results``.
+The documentation page `Vuforia Query Web API`_ states that 10 is the maximum allowed value of ``max_num_results``.
 However, the maximum allowed value is 50.
 
 A response to an invalid query may have an ``application/json`` content type but include text (not JSON) data.
@@ -158,18 +158,18 @@ After deleting a target, for up to approximately 30 seconds, matching it with a
 
 A target with the name ``\uffff`` gets stuck in processing.
 
-The documentation page `How To Perform an Image Recognition Query`_ states that "The API accepts requests with unknown data fields, and ignore the unknown fields.".
+The documentation page `Vuforia Query Web API`_ states that "The API accepts requests with unknown data fields, and ignore the unknown fields.".
 This is not the case.
 
-The documentation page `How To Perform an Image Recognition Query`_ states "Maximum image size: 2.1 MPixel. 512 KiB for JPEG, 2MiB for PNG".
+The documentation page `Vuforia Query Web API`_ states "Maximum image size: 2.1 MPixel. 512 KiB for JPEG, 2MiB for PNG".
 However, JPEG images up to 2MiB are accepted.
 
 The ``request_count`` in a database summary is always ``0``.
 
 The documentation for the target summary report says "Note: tracking_rating and ``reco_rating`` are provided only when status = success.".
 However, ``reco_rating`` is never provided and ``tracking_rating`` is provided even when the status is "failed".
 
-.. _How To Perform an Image Recognition Query: https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query
+.. _Vuforia Query Web API: https://library.vuforia.com/web-api/vuforia-query-web-api
 
 Release Process
 ---------------

docs/source/differences-to-vws.rst

@@ -97,7 +97,7 @@ Result codes
 ------------
 
 Result codes are returned by requests to Vuforia to help with debugging.
-See `How To Interpret VWS API Result Codes <https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API#How-To-Interperete-VWS-API-Result-Codes>`_ for details of the available result codes.
+See `VWS API Result Codes <https://library.vuforia.com/web-api/cloud-targets-web-services-api#result-codes>`_ for details of the available result codes.
 There are some result codes which the mock cannot return.
 
 These are:

src/mock_vws/_constants.py

@@ -10,7 +10,7 @@ class ResultCodes(Enum):
     Constants representing various VWS result codes.
 
     See
-    https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API.html#How-To-Interperete-VWS-API-Result-Codes
+    https://library.vuforia.com/web-api/cloud-targets-web-services-api#result-codes.
 
     Some codes here are not documented in the above link.
     """

src/mock_vws/_flask_server/vwq.py

@@ -2,7 +2,7 @@
 A fake implementation of the Vuforia Web Query API using Flask.
 
 See
-https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query
+https://library.vuforia.com/web-api/vuforia-query-web-api
 """
 
 import email.utils

src/mock_vws/_query_validators/image_validators.py

@@ -70,7 +70,7 @@ def validate_image_file_size(
     image = parsed.get("image").raw
 
     # This is the documented maximum size of a PNG as per.
-    # https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query.
+    # https://library.vuforia.com/web-api/vuforia-query-web-api.
     # However, the tests show that this maximum size also applies to JPEG
     # files.
     max_bytes = 2 * 1024 * 1024

src/mock_vws/_requests_mock_server/mock_web_query_api.py

@@ -2,7 +2,7 @@
 A fake implementation of the Vuforia Web Query API.
 
 See
-https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query
+https://library.vuforia.com/web-api/vuforia-query-web-api
 """
 
 from __future__ import annotations

tests/mock_vws/test_query.py

@@ -1,7 +1,7 @@
 """
 Tests for the mock of the query endpoint.
 
-https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query.
+https://library.vuforia.com/web-api/vuforia-query-web-api.
 """
 
 from __future__ import annotations
@@ -738,7 +738,7 @@ def test_valid_accepted(
         This is because uploading 50 images would be very slow.
 
         The documentation at
-        https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query
+        https://library.vuforia.com/web-api/vuforia-query-web-api
         states that this must be between 1 and 10, but in practice, 50 is the
         maximum.
         """
@@ -792,7 +792,7 @@ def test_out_of_range(
         of the range (1, 50).
 
         The documentation at
-        https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query.
+        https://library.vuforia.com/web-api/vuforia-query-web-api.
         states that this must be between 1 and 10, but in practice, 50 is the
         maximum.
         """
@@ -1271,7 +1271,7 @@ def test_png(
     ) -> None:  # pragma: no cover
         """
         According to
-        https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query.
+        https://library.vuforia.com/web-api/vuforia-query-web-api.
         the maximum file size is "2MiB for PNG".
 
         Above this limit, a ``REQUEST_ENTITY_TOO_LARGE`` response is returned.
@@ -1352,7 +1352,7 @@ def test_jpeg(
     ) -> None:  # pragma: no cover
         """
         According to
-        https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query.
+        https://library.vuforia.com/web-api/vuforia-query-web-api.
         the maximum file size is "512 KiB for JPEG".
         However, this test shows that the maximum size for JPEG is 2 MiB.
 

tests/mock_vws/utils/assertions.py

@@ -114,7 +114,7 @@ def assert_vws_response(
     """
     Assert that a VWS response is as expected, at least in part.
 
-    https://library.vuforia.com/articles/Solution/How-To-Use-the-Vuforia-Web-Services-API.html#How-To-Interperete-VWS-API-Result-Codes
+    https://library.vuforia.com/web-api/cloud-targets-web-services-api#result-codes
     implies that the expected status code can be worked out from the result
     code. However, this is not the case as the real results differ from the
     documentation.