Skip to content

Commit 2a1a191

Browse files
VaiTonraphael0202
andauthored
fix(openapi): Fix logo_id path param in /ann/search/{logo_id} (#1840)
Co-authored-by: Raphaël Bournhonesque <raphael0202@users.noreply.github.com>
1 parent 7d7c868 commit 2a1a191

File tree

1 file changed

+18
-11
lines changed

1 file changed

+18
-11
lines changed

docs/references/api.yml

Lines changed: 18 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -286,7 +286,7 @@ paths:
286286
287287
The annotation is an integer that can take 4 values: `0`, `1`, `2`, `-1`. `0` means the insight is incorrect
288288
(so it won't be applied), `1` means it is correct (so it will be applied) and `-1` means the insight
289-
won't be returned to the user (_skip_). `2` is used when user submit some data to the annotate endpoint
289+
won't be returned to the user (_skip_). `2` is used when user submit some data to the annotate endpoint
290290
(for example in some cases of category annotation or ingredients spellcheck).
291291
292292
We use the voting mecanism system to remember which insight to skip for a user (authenticated or not).
@@ -412,7 +412,7 @@ paths:
412412
in: query
413413
description: |
414414
The minimum y-coordinate for cropping, relative to the image height.
415-
We use relative coordinates, with (0, 0) being the upper left corner and
415+
We use relative coordinates, with (0, 0) being the upper left corner and
416416
(1, 1) being the lower right corner.
417417
example: 0.47795143723487854
418418
schema:
@@ -422,7 +422,7 @@ paths:
422422
- name: x_min
423423
description: |
424424
The minimum x-coordinate for cropping, relative to the image width.
425-
We use relative coordinates, with (0, 0) being the upper left corner and
425+
We use relative coordinates, with (0, 0) being the upper left corner and
426426
(1, 1) being the lower right corner.
427427
in: query
428428
example: 0.5583494305610657
@@ -433,7 +433,7 @@ paths:
433433
- name: y_max
434434
description: |
435435
The maximum y-coordinate for cropping, relative to the image height.
436-
We use relative coordinates, with (0, 0) being the upper left corner and
436+
We use relative coordinates, with (0, 0) being the upper left corner and
437437
(1, 1) being the lower right corner.
438438
in: query
439439
example: 0.5653171539306641
@@ -444,7 +444,7 @@ paths:
444444
- name: x_max
445445
description: |
446446
The maximum x-coordinate for cropping, relative to the image width.
447-
We use relative coordinates, with (0, 0) being the upper left corner and
447+
We use relative coordinates, with (0, 0) being the upper left corner and
448448
(1, 1) being the lower right corner.
449449
in: query
450450
example: 0.6795185804367065
@@ -576,7 +576,7 @@ paths:
576576
summary: Search for logos
577577
operationId: searchLogos
578578
description: |
579-
Search for logos detected using the universal-logo-detector model that
579+
Search for logos detected using the universal-logo-detector model that
580580
meet some criteria (annotation status, annotated, type,...)
581581
parameters:
582582
- $ref: "#/components/parameters/server_type"
@@ -686,14 +686,21 @@ paths:
686686
application/json:
687687
schema:
688688
$ref: "#/components/schemas/LogoANNSearchResponse"
689-
/ann/search/{logo_id:int}:
689+
690+
/ann/search/{logo_id}:
690691
get:
691692
tags:
692693
- ANN Search
693694
summary: Approximate search for nearest neighbors of a specified query logo
694695
operationId: searchNearestNeighborsByLogoId
695696
description: Return ID and distance of each logo found, the number of neighbors returned and the ID of the query logo.
696697
parameters:
698+
- name: logo_id
699+
in: path
700+
required: true
701+
description: The ID of the logo to search for.
702+
schema:
703+
type: integer
697704
- $ref: "#/components/parameters/ann_search_count"
698705
- $ref: "#/components/parameters/server_type"
699706
responses:
@@ -1399,8 +1406,8 @@ paths:
13991406
type: array
14001407
items:
14011408
type: object
1402-
1403-
1409+
1410+
14041411
"400":
14051412
description: "An HTTP 400 is returned if the provided parameters are invalid"
14061413
/predict/ocr_prediction:
@@ -1668,7 +1675,7 @@ paths:
16681675
operationId: importBatchJobResults
16691676
description: |
16701677
Import batch job data into Robotoff database. This endpoint is secured and requires bearer authentication.
1671-
1678+
16721679
This endpoint is mainly used by the batch job once the job is finished.
16731680
security:
16741681
- batch_job_key: []
@@ -2066,7 +2073,7 @@ tags:
20662073
- name: Image Processing
20672074
description: |
20682075
Endpoints for processing and manipulating images, including cropping and running prediction models.
2069-
- name: Image Management
2076+
- name: Image Management
20702077
description: |
20712078
Endpoints for managing and retrieving image data and metadata.
20722079
- name: Image Predictions

0 commit comments

Comments
 (0)