Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc: Added documentation for 5 Collection APIs #898

Merged
merged 12 commits into from
Sep 16, 2022

Conversation

Jagrutiti
Copy link
Member

What

Added documentation for the following APIs:

  1. /api/v1/predictions/ PredictionCollection()
  2. /api/v1/images/prediction/collection ImagePredictionCollection()
  3. /api/v1/images ImageCollection
  4. /api/v1/annotation/collection LogoAnnotationCollection
  5. /api/v1/questions/unanswered/ UnansweredQuestionCollection

Part of

Closes

@Jagrutiti Jagrutiti requested a review from a team as a code owner September 13, 2022 16:41
Copy link
Member

@alexgarel alexgarel left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some suggestions :-)

I let you merge afterwards.

doc/references/api.md Outdated Show resolved Hide resolved
doc/references/api.md Outdated Show resolved Hide resolved
doc/references/api.md Outdated Show resolved Hide resolved
doc/references/api.md Outdated Show resolved Hide resolved
doc/references/api.md Outdated Show resolved Hide resolved
doc/references/api.md Outdated Show resolved Hide resolved
doc/references/api.md Outdated Show resolved Hide resolved
doc/references/api.md Outdated Show resolved Hide resolved
doc/references/api.md Outdated Show resolved Hide resolved
doc/references/api.md Outdated Show resolved Hide resolved
Jagrutiti and others added 10 commits September 14, 2022 19:42
Co-authored-by: Alex Garel <alex@garel.org>
Co-authored-by: Alex Garel <alex@garel.org>
Co-authored-by: Alex Garel <alex@garel.org>
Co-authored-by: Alex Garel <alex@garel.org>
Co-authored-by: Alex Garel <alex@garel.org>
Co-authored-by: Alex Garel <alex@garel.org>
Co-authored-by: Alex Garel <alex@garel.org>
Co-authored-by: Alex Garel <alex@garel.org>
Co-authored-by: Alex Garel <alex@garel.org>
@alexgarel alexgarel changed the title doc (feat): Added documentation for 5 Collection APIs doc: Added documentation for 5 Collection APIs Sep 14, 2022
@codecov
Copy link

codecov bot commented Sep 16, 2022

Codecov Report

Merging #898 (9d869c1) into master (1e63ca2) will increase coverage by 7.92%.
The diff coverage is 75.18%.

@@            Coverage Diff             @@
##           master     #898      +/-   ##
==========================================
+ Coverage   44.73%   52.65%   +7.92%     
==========================================
  Files          96       92       -4     
  Lines        6981     7015      +34     
==========================================
+ Hits         3123     3694     +571     
+ Misses       3858     3321     -537     
Impacted Files Coverage Δ
robotoff/cli/batch.py 0.00% <ø> (ø)
robotoff/cli/insights.py 0.00% <0.00%> (ø)
robotoff/insights/dataclass.py 100.00% <ø> (ø)
robotoff/prediction/ocr/brand.py 68.62% <0.00%> (ø)
robotoff/prediction/ocr/expiration_date.py 25.71% <ø> (ø)
robotoff/prediction/ocr/image_flag.py 41.02% <ø> (ø)
robotoff/prediction/ocr/label.py 72.30% <0.00%> (ø)
robotoff/prediction/ocr/packager_code.py 73.07% <ø> (ø)
robotoff/prediction/ocr/product_weight.py 49.10% <0.00%> (+1.28%) ⬆️
robotoff/products.py 42.75% <ø> (+2.26%) ⬆️
... and 61 more

📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more

@sonarqubecloud
Copy link

Kudos, SonarCloud Quality Gate passed!    Quality Gate passed

Bug A 0 Bugs
Vulnerability A 0 Vulnerabilities
Security Hotspot E 6 Security Hotspots
Code Smell A 115 Code Smells

0.0% 0.0% Coverage
0.1% 0.1% Duplication

@alexgarel
Copy link
Member

Thanks @Jagrutiti :-)

@alexgarel alexgarel merged commit 2106323 into master Sep 16, 2022
@alexgarel alexgarel deleted the doc-unanswered-questions-and-collections-api branch September 16, 2022 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

2 participants