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

Enhancement: add storage_path parameter to post_document API #5217

Merged
merged 3 commits into from Jan 3, 2024

Conversation

bevanjkay
Copy link
Contributor

Proposed change

This PR adds an additional parameter to the post_document API endpoint to allow setting a storage_path.

Closes #5211

Type of change

  • Bug fix: non-breaking change which fixes an issue.
  • New feature: non-breaking change which adds functionality. Please read the important note above.
  • Breaking change: fix or feature that would cause existing functionality to not work as expected.
  • Documentation only.
  • Other. Please explain:

Checklist:

  • I have read & agree with the contributing guidelines.
  • If applicable, I have included testing coverage for new code in this PR, for backend and / or front-end changes.
  • If applicable, I have tested my code for new features & regressions on both mobile & desktop devices, using the latest version of major browsers.
  • If applicable, I have checked that all tests pass, see documentation.
  • I have run all pre-commit hooks, see documentation.
  • I have made corresponding changes to the documentation as needed.
  • I have checked my modifications for any breaking changes.

@bevanjkay bevanjkay requested a review from a team as a code owner January 3, 2024 04:20
@paperless-ngx-secretary paperless-ngx-secretary bot added backend documentation Improvements or additions to documentation non-trivial Requires approval by several team members labels Jan 3, 2024
@paperless-ngx-secretary
Copy link

Hello @bevanjkay,

thank you very much for submitting this PR to us!

This is what will happen next:

  1. My robotic colleagues will check your changes to see if they break anything. You can see the progress below.
  2. Once that is finished, human contributors from paperless-ngx review your changes. Since this is a non-trivial change, a review from at least two contributors is required.
  3. Please improve anything that comes up during the review until your pull request gets approved.
  4. Your pull request will be merged into the dev branch. Changes there will be tested further.
  5. Eventually, changes from you and other contributors will be merged into main and a new release will be made.

Please allow up to 7 days for an initial review. We're all very excited about new pull requests but we only do this as a hobby.
If any action will be required by you, please reply within a month.

@github-actions github-actions bot added the enhancement New feature label Jan 3, 2024
@shamoon shamoon changed the title Feature: add storage_path parameter to post_document API Enhancement: add storage_path parameter to post_document API Jan 3, 2024
Copy link

codecov bot commented Jan 3, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a237a33) 96.02% compared to head (16b67da) 96.30%.
Report is 131 commits behind head on dev.

❗ Current head 16b67da differs from pull request most recent head 3e8572e. Consider uploading reports for the commit 3e8572e to get more accurate results

Additional details and impacted files
@@            Coverage Diff             @@
##              dev    #5217      +/-   ##
==========================================
+ Coverage   96.02%   96.30%   +0.28%     
==========================================
  Files         372      392      +20     
  Lines       14184    15013     +829     
  Branches     1114     1169      +55     
==========================================
+ Hits        13620    14459     +839     
+ Misses        560      550      -10     
  Partials        4        4              
Flag Coverage Δ
backend 94.93% <ø> (+0.26%) ⬆️
frontend 97.88% <100.00%> (+0.28%) ⬆️

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

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@bevanjkay
Copy link
Contributor Author

bevanjkay commented Jan 3, 2024

@shamoon Thanks for running CI, it looks like the failing test is a workflow issue, and not an issue with the PR?

@shamoon shamoon removed the documentation Improvements or additions to documentation label Jan 3, 2024
@shamoon shamoon enabled auto-merge (squash) January 3, 2024 08:14
@shamoon shamoon disabled auto-merge January 3, 2024 08:14
@shamoon shamoon enabled auto-merge (squash) January 3, 2024 08:14
Copy link
Member

@shamoon shamoon left a comment

Choose a reason for hiding this comment

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

Thanks the PR, I just fixed the coverage.

Seems pretty safe since this is basically copied from the other fields.

@shamoon shamoon added this to the Next Release milestone Jan 3, 2024
@bevanjkay
Copy link
Contributor Author

Thanks for updating the missing test @shamoon

@shamoon shamoon merged commit bbf64b7 into paperless-ngx:dev Jan 3, 2024
18 checks passed
Copy link
Contributor

github-actions bot commented Feb 3, 2024

This pull request has been automatically locked since there has not been any recent activity after it was closed. Please open a new discussion or issue for related concerns.

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Feb 3, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backend enhancement New feature non-trivial Requires approval by several team members
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants