Merge pull request #2116 from VWS-Python/vws-links

adamtheturtle · web-flow · commit 7196093b56cf · 2024-06-11T09:42:35.000+01:00
Update VWS links to work again
diff --git a/docs/source/contributing.rst b/docs/source/contributing.rst
@@ -172,7 +172,7 @@ 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".
 
-.. _Vuforia Query Web API: https://library.vuforia.com/web-api/vuforia-query-web-api
+.. _Vuforia Query Web API: https://developer.vuforia.com/library/web-api/vuforia-query-web-api
 
 Release Process
 ---------------
diff --git a/docs/source/differences-to-vws.rst b/docs/source/differences-to-vws.rst
@@ -86,7 +86,7 @@ Result codes
 ------------
 
 Result codes are returned by requests to Vuforia to help with debugging.
-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.
+See `VWS API Result Codes <https://developer.vuforia.com/library/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:
diff --git a/src/mock_vws/_constants.py b/src/mock_vws/_constants.py
@@ -10,7 +10,7 @@ class ResultCodes(Enum):
     Constants representing various VWS result codes.
 
     See
-    https://library.vuforia.com/web-api/cloud-targets-web-services-api#result-codes.
+    https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#result-codes.
 
     Some codes here are not documented in the above link.
     """
@@ -42,7 +42,7 @@ class TargetStatuses(Enum):
     Constants representing VWS target statuses.
 
     See the 'status' field in
-    https://library.vuforia.com/web-api/cloud-targets-web-services-api#target-record
+    https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#target-record
     """
 
     PROCESSING = "processing"
diff --git a/src/mock_vws/_flask_server/vwq.py b/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/web-api/vuforia-query-web-api
+https://developer.vuforia.com/library/web-api/vuforia-query-web-api
 """
 
 import email.utils
diff --git a/src/mock_vws/_flask_server/vws.py b/src/mock_vws/_flask_server/vws.py
@@ -2,7 +2,7 @@
 A fake implementation of the Vuforia Web Services API.
 
 See
-https://library.vuforia.com/web-api/cloud-targets-web-services-api
+https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api
 """
 
 import base64
@@ -153,7 +153,7 @@ def add_target() -> Response:
     Add a target.
 
     Fake implementation of
-    https://library.vuforia.com/web-api/cloud-targets-web-services-api#add
+    https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#add
     """
     settings = VWSSettings.model_validate(obj={})
     databases = get_all_databases()
@@ -225,7 +225,7 @@ def get_target(target_id: str) -> Response:
     Get details of a target.
 
     Fake implementation of
-    https://library.vuforia.com/web-api/cloud-targets-web-services-api#target-record
+    https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#target-record
     """
     databases = get_all_databases()
     database = get_database_matching_server_keys(
@@ -282,7 +282,7 @@ def delete_target(target_id: str) -> Response:
     Delete a target.
 
     Fake implementation of
-    https://library.vuforia.com/web-api/cloud-targets-web-services-api#delete
+    https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#delete
     """
     settings = VWSSettings.model_validate(obj={})
     databases = get_all_databases()
@@ -335,7 +335,7 @@ def database_summary() -> Response:
     Get a database summary report.
 
     Fake implementation of
-    https://library.vuforia.com/web-api/cloud-targets-web-services-api#summary-report
+    https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#summary-report
     """
     databases = get_all_databases()
     database = get_database_matching_server_keys(
@@ -388,7 +388,7 @@ def target_summary(target_id: str) -> Response:
     Get a summary report for a target.
 
     Fake implementation of
-    https://library.vuforia.com/web-api/cloud-targets-web-services-api#retrieve-report
+    https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#retrieve-report
     """
     databases = get_all_databases()
     database = get_database_matching_server_keys(
@@ -442,7 +442,7 @@ def get_duplicates(target_id: str) -> Response:
     Get targets which may be considered duplicates of a given target.
 
     Fake implementation of
-    https://library.vuforia.com/web-api/cloud-targets-web-services-api#check
+    https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#check
     """
     databases = get_all_databases()
     settings = VWSSettings.model_validate(obj={})
@@ -502,7 +502,7 @@ def target_list() -> Response:
     Get a list of all targets.
 
     Fake implementation of
-    https://library.vuforia.com/web-api/cloud-targets-web-services-api#details-list
+    https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#details-list
     """
     databases = get_all_databases()
     database = get_database_matching_server_keys(
@@ -543,7 +543,7 @@ def update_target(target_id: str) -> Response:
     Update a target.
 
     Fake implementation of
-    https://library.vuforia.com/web-api/cloud-targets-web-services-api#update
+    https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#update
     """
     settings = VWSSettings.model_validate(obj={})
     # We do not use ``request.get_json(force=True)`` because this only works
diff --git a/src/mock_vws/_query_validators/image_validators.py b/src/mock_vws/_query_validators/image_validators.py
@@ -77,7 +77,7 @@ def validate_image_file_size(
     image_value = image_part.stream.read()
 
     # This is the documented maximum size of a PNG as per.
-    # https://library.vuforia.com/web-api/vuforia-query-web-api.
+    # https://developer.vuforia.com/library/web-api/vuforia-query-web-api.
     # However, the tests show that this maximum size also applies to JPEG
     # files.
     max_bytes = 2 * 1024 * 1024
diff --git a/src/mock_vws/_requests_mock_server/mock_web_query_api.py b/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/web-api/vuforia-query-web-api
+https://developer.vuforia.com/library/web-api/vuforia-query-web-api
 """
 
 from __future__ import annotations
diff --git a/src/mock_vws/_requests_mock_server/mock_web_services_api.py b/src/mock_vws/_requests_mock_server/mock_web_services_api.py
@@ -2,7 +2,7 @@
 A fake implementation of the Vuforia Web Services API.
 
 See
-https://library.vuforia.com/web-api/cloud-targets-web-services-api
+https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api
 """
 
 from __future__ import annotations
@@ -123,7 +123,7 @@ def add_target(self, request: Request, context: Context) -> str:
         Add a target.
 
         Fake implementation of
-        https://library.vuforia.com/web-api/cloud-targets-web-services-api#add
+        https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#add
         """
         try:
             run_services_validators(
@@ -196,7 +196,7 @@ def delete_target(self, request: Request, context: Context) -> str:
         Delete a target.
 
         Fake implementation of
-        https://library.vuforia.com/web-api/cloud-targets-web-services-api#delete
+        https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#delete
         """
         try:
             run_services_validators(
@@ -259,7 +259,7 @@ def database_summary(self, request: Request, context: Context) -> str:
         Get a database summary report.
 
         Fake implementation of
-        https://library.vuforia.com/web-api/cloud-targets-web-services-api#summary-report
+        https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#summary-report
         """
         try:
             run_services_validators(
@@ -321,7 +321,7 @@ def target_list(self, request: Request, context: Context) -> str:
         Get a list of all targets.
 
         Fake implementation of
-        https://library.vuforia.com/web-api/cloud-targets-web-services-api#details-list
+        https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#details-list
         """
         try:
             run_services_validators(
@@ -377,7 +377,7 @@ def get_target(self, request: Request, context: Context) -> str:
         Get details of a target.
 
         Fake implementation of
-        https://library.vuforia.com/web-api/cloud-targets-web-services-api#target-record
+        https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#target-record
         """
         try:
             run_services_validators(
@@ -441,7 +441,7 @@ def get_duplicates(self, request: Request, context: Context) -> str:
         Get targets which may be considered duplicates of a given target.
 
         Fake implementation of
-        https://library.vuforia.com/web-api/cloud-targets-web-services-api#check
+        https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#check
         """
         try:
             run_services_validators(
@@ -511,7 +511,7 @@ def update_target(self, request: Request, context: Context) -> str:
         Update a target.
 
         Fake implementation of
-        https://library.vuforia.com/web-api/cloud-targets-web-services-api#update
+        https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#update
         """
         try:
             run_services_validators(
@@ -616,7 +616,7 @@ def target_summary(self, request: Request, context: Context) -> str:
         Get a summary report for a target.
 
         Fake implementation of
-        https://library.vuforia.com/web-api/cloud-targets-web-services-api#retrieve-report
+        https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#retrieve-report
         """
         try:
             run_services_validators(
diff --git a/tests/mock_vws/test_get_duplicates.py b/tests/mock_vws/test_get_duplicates.py
@@ -165,7 +165,7 @@ def test_active_flag(
         Targets with `active_flag` set to `False` can have duplicates.
         Targets with `active_flag` set to `False` are not found as duplicates.
 
-        https://library.vuforia.com/web-api/cloud-targets-web-services-api#check
+        https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#check
         says:
 
         '''
diff --git a/tests/mock_vws/test_get_target.py b/tests/mock_vws/test_get_target.py
@@ -1,7 +1,7 @@
 """
 Tests for getting a target record.
 
-https://library.vuforia.com/web-api/cloud-targets-web-services-api#target-record
+https://developer.vuforia.com/library/web-api/cloud-targets-web-services-api#target-record
 """
 
 from __future__ import annotations
diff --git a/tests/mock_vws/test_query.py b/tests/mock_vws/test_query.py
@@ -1,7 +1,7 @@
 """
 Tests for the mock of the query endpoint.
 
-https://library.vuforia.com/web-api/vuforia-query-web-api.
+https://developer.vuforia.com/library/web-api/vuforia-query-web-api.
 """
 
 from __future__ import annotations
@@ -803,7 +803,7 @@ def test_valid_accepted(
         This is because uploading 50 images would be very slow.
 
         The documentation at
-        https://library.vuforia.com/web-api/vuforia-query-web-api
+        https://developer.vuforia.com/library/web-api/vuforia-query-web-api
         states that this must be between 1 and 10, but in practice, 50 is the
         maximum.
         """
@@ -857,7 +857,7 @@ def test_out_of_range(
         of the range (1, 50).
 
         The documentation at
-        https://library.vuforia.com/web-api/vuforia-query-web-api.
+        https://developer.vuforia.com/library/web-api/vuforia-query-web-api.
         states that this must be between 1 and 10, but in practice, 50 is the
         maximum.
         """
@@ -1323,7 +1323,7 @@ def test_png(
     ) -> None:  # pragma: no cover
         """
         According to
-        https://library.vuforia.com/web-api/vuforia-query-web-api.
+        https://developer.vuforia.com/library/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.
@@ -1400,7 +1400,7 @@ def test_jpeg(
     ) -> None:  # pragma: no cover
         """
         According to
-        https://library.vuforia.com/web-api/vuforia-query-web-api.
+        https://developer.vuforia.com/library/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.
 
diff --git a/tests/mock_vws/utils/assertions.py b/tests/mock_vws/utils/assertions.py
@@ -120,7 +120,7 @@ def assert_vws_response(
     """
     Assert that a VWS response is as expected, at least in part.
 
-    https://library.vuforia.com/web-api/cloud-targets-web-services-api#result-codes
+    https://developer.vuforia.com/library/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.
