Skip to content

Commit dbd38d9

Browse files
committed
Remove outdated documentation for removed options
1 parent a2275b9 commit dbd38d9

File tree

3 files changed

+0
-69
lines changed

3 files changed

+0
-69
lines changed

docs/source/differences-to-vws.rst

Lines changed: 0 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -37,21 +37,6 @@ The criteria for these images is not defined by the Vuforia documentation.
3737
The mock is more forgiving than the real Vuforia Web Services.
3838
Therefore, an image given a 'success' status by the mock may not be given a 'success' status by the real Vuforia Web Services.
3939

40-
Matching targets in the processing state
41-
----------------------------------------
42-
43-
Matching a target which is in the processing state sometimes returns a successful response with no results.
44-
Sometimes a 500 (``INTERNAL SERVER ERROR``) response is given.
45-
The mock always gives a 500 response.
46-
47-
Matching deleted targets
48-
------------------------
49-
50-
Matching a target which has been deleted returns a 500 (``INTERNAL SERVER ERROR``) response within the first few seconds.
51-
This time frame is not consistent on the real Vuforia Web Services.
52-
On the mock, this time frame is three seconds by default.
53-
:py:class:`~mock_vws.MockVWS` takes a parameter :paramref:`~mock_vws.MockVWS.query_processes_deletion_seconds` to change this.
54-
5540
Accepted date formats for the Query API
5641
---------------------------------------
5742

docs/source/docker.rst

Lines changed: 0 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -118,20 +118,6 @@ Target manager container
118118
Query container
119119
~~~~~~~~~~~~~~~
120120

121-
.. envvar:: DELETION_PROCESSING_SECONDS
122-
123-
The number of seconds after a target deletion is recognized that the
124-
query endpoint will return a 500 response on a match.
125-
126-
Default: 3.0
127-
128-
.. envvar:: DELETION_RECOGNITION_SECONDS
129-
130-
The number of seconds after a target has been deleted that the query
131-
endpoint will still recognize the target for.
132-
133-
Default: 2.0
134-
135121
.. envvar:: QUERY_IMAGE_MATCHER
136122

137123
The matcher to use for the query endpoint.

src/mock_vws/_query_validators/exceptions.py

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@
66
import textwrap
77
import uuid
88
from http import HTTPStatus
9-
from pathlib import Path
109

1110
from mock_vws._constants import ResultCodes
1211
from mock_vws._mock_common import json_dump
@@ -628,45 +627,6 @@ def __init__(self) -> None: # pragma: no cover
628627
}
629628

630629

631-
class DeletedTargetMatched(ValidatorException):
632-
"""
633-
Exception raised when target which was recently deleted is matched.
634-
"""
635-
636-
def __init__(self) -> None:
637-
"""
638-
Attributes:
639-
status_code: The status code to use in a response if this is
640-
raised.
641-
response_text: The response text to use in a response if this is
642-
raised.
643-
"""
644-
super().__init__()
645-
self.status_code = HTTPStatus.INTERNAL_SERVER_ERROR
646-
date = email.utils.formatdate(None, localtime=False, usegmt=True)
647-
# We return an example 500 response.
648-
# Each response given by Vuforia is different.
649-
#
650-
# Sometimes Vuforia will ignore matching targets with the
651-
# processing status, but we choose to:
652-
# * Do the most unexpected thing.
653-
# * Be consistent with every response.
654-
resources_dir = Path(__file__).parent.parent / "resources"
655-
filename = "deleted_target_matched_response.html"
656-
deleted_target_matched_resp_file = resources_dir / filename
657-
self.response_text = Path(deleted_target_matched_resp_file).read_text(
658-
encoding="utf-8",
659-
)
660-
self.headers = {
661-
"Connection": "keep-alive",
662-
"Content-Type": "text/html;charset=iso-8859-1",
663-
"Server": "nginx",
664-
"Cache-Control": "must-revalidate,no-cache,no-store",
665-
"Date": date,
666-
"Content-Length": str(len(self.response_text)),
667-
}
668-
669-
670630
class NoContentType(ValidatorException):
671631
"""
672632
Exception raised when a content type is either not given or is empty.

0 commit comments

Comments
 (0)