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

docs: Specified that the API template only supports images for now #609

Merged
merged 2 commits into from
Nov 12, 2021

Conversation

fg-mindee
Copy link
Contributor

@fg-mindee fg-mindee commented Nov 12, 2021

Following up on some QA feedback, this PR introduces the following modifications:

  • specifies that all routes support only images and not PDF for now
  • cleaned the expected route status
  • improved the CI check: it used to check that the base URL is accessible, and now it will check whether it can access the swagger/docs

Any feedback is welcome!

cc @RBMindee

@fg-mindee fg-mindee added topic: documentation Improvements or additions to documentation type: enhancement Improvement ext: api Related to api folder labels Nov 12, 2021
@fg-mindee fg-mindee added this to the 0.4.1 milestone Nov 12, 2021
@fg-mindee fg-mindee self-assigned this Nov 12, 2021
@codecov
Copy link

codecov bot commented Nov 12, 2021

Codecov Report

Merging #609 (9151f63) into main (250a3cb) will decrease coverage by 0.02%.
The diff coverage is n/a.

Impacted file tree graph

@@            Coverage Diff             @@
##             main     #609      +/-   ##
==========================================
- Coverage   96.06%   96.03%   -0.03%     
==========================================
  Files         110      110              
  Lines        4265     4265              
==========================================
- Hits         4097     4096       -1     
- Misses        168      169       +1     
Flag Coverage Δ
unittests 96.03% <ø> (-0.03%) ⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files Coverage Δ
...dels/detection/differentiable_binarization/base.py 91.19% <0.00%> (-0.63%) ⬇️

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update eb5db48...9151f63. Read the comment docs.

Copy link
Collaborator

@charlesmindee charlesmindee left a comment

Choose a reason for hiding this comment

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

Thanks for the PR!

@fg-mindee fg-mindee merged commit a792a82 into main Nov 12, 2021
@fg-mindee fg-mindee deleted the api-improvements branch November 12, 2021 13:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ext: api Related to api folder topic: documentation Improvements or additions to documentation type: enhancement Improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants