Skip to content

Commit 8f29942

Browse files
Merge pull request #678 from adamtheturtle/document-weirdness
Document weirdness in API recently learned
2 parents b4eb3ef + e82637d commit 8f29942

File tree

1 file changed

+11
-3
lines changed

1 file changed

+11
-3
lines changed

CONTRIBUTING.rst

Lines changed: 11 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -165,13 +165,13 @@ Some of the `Vuforia Web Services documentation <https://library.vuforia.com/art
165165
However, other `Vuforia Web Services documentation <https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query>`__ is more accurate: “Maximum image size: 2.1 MPixel.
166166
512 KiB for JPEG, 2MiB for PNG”.
167167

168-
The documentation page `How To Perform an Image Recognition Query <https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query>`__ states that the ``Content-Type`` header must be set to ``multipart/form-data``.
168+
The documentation page `How To Perform an Image Recognition Query`_ states that the ``Content-Type`` header must be set to ``multipart/form-data``.
169169
However, it must be set to ``multipart/form-data; boundary=<BOUNDARY>`` where ``<BOUNDARY>`` is the boundary used when encoding the form data.
170170

171-
The documentation page `How To Perform an Image Recognition Query <https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query>`__ states that ``Content-Type`` with be the only response header.
171+
The documentation page `How To Perform an Image Recognition Query`_ states that ``Content-Type`` will be the only response header.
172172
This is not the case.
173173

174-
The documentation page `How To Perform an Image Recognition Query <https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query>`__ states that 10 is the maximum allowed value of ``max_num_results``.
174+
The documentation page `How To Perform an Image Recognition Query`_ states that 10 is the maximum allowed value of ``max_num_results``.
175175
However, the maximum allowed value is 50.
176176

177177
A response to an invalid query may have an ``application/json`` content type but include text (not JSON) data.
@@ -180,6 +180,14 @@ After deleting a target, for up to approximately 30 seconds, matching it with a
180180

181181
A target with the name ``\uffff`` gets stuck in processing.
182182

183+
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.".
184+
This is not the case.
185+
186+
The documentation page `How To Perform an Image Recognition Query`_ states "Maximum image size: 2.1 MPixel. 512 KiB for JPEG, 2MiB for PNG".
187+
However, JPEG images up to 2MiB are accepted.
188+
189+
.. _How To Perform an Image Recognition Query: https://library.vuforia.com/articles/Solution/How-To-Perform-an-Image-Recognition-Query
190+
183191
Performing a release
184192
--------------------
185193

0 commit comments

Comments
 (0)