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

feat(api): REST API to schedule the bulk-scan #2483

Merged
merged 1 commit into from
Aug 28, 2023

Conversation

dushimsam
Copy link
Contributor

@dushimsam dushimsam commented Jun 19, 2023

Description

Added the API to schedule the bulk scan for an item, given relevant information in the request body.

Changes

  1. Added a new method in UploadTreeController to handle the logic.
  2. Updated the main file(index.php) by adding a new route POST /uploads/{id}/items/{itemId}/bulk-scan.
  3. Updated the openapi.yaml file to write the new API's documentation.

How to test

Make a POST request on the endpoint: /uploads/{id}/items/{itemId}/bulk-scan.
This endpoint is expected to return the jobId which corresponds to this bulk scan.

Screenshots

image

Related Issue:

Fixes #2472

cc: @shaheemazmalmmd @GMishx

@GMishx GMishx added needs code review needs test GSOC-23 Label to tag pull request which are part of the GSOC 2023 labels Jun 22, 2023
@github-actions github-actions bot added the has merge conflicts PR to be rebased label Jun 29, 2023
@github-actions
Copy link

This pull request has conflicts, please rebase with master to resolve those before we can evaluate the pull request.

src/www/ui/api/documentation/openapi.yaml Outdated Show resolved Hide resolved
src/www/ui/api/documentation/openapi.yaml Outdated Show resolved Hide resolved
src/www/ui/api/documentation/openapi.yaml Outdated Show resolved Hide resolved
src/www/ui/api/documentation/openapi.yaml Outdated Show resolved Hide resolved
src/www/ui/api/documentation/openapi.yaml Outdated Show resolved Hide resolved
src/www/ui/api/Controllers/UploadTreeController.php Outdated Show resolved Hide resolved
src/www/ui/api/documentation/openapi.yaml Outdated Show resolved Hide resolved
@github-actions github-actions bot added has merge conflicts PR to be rebased and removed has merge conflicts PR to be rebased labels Jul 6, 2023
@github-actions
Copy link

github-actions bot commented Jul 7, 2023

This pull request has conflicts, please rebase with master to resolve those before we can evaluate the pull request.

Copy link
Member

@GMishx GMishx left a comment

Choose a reason for hiding this comment

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

Changes looks good.

Copy link
Member

@GMishx GMishx left a comment

Choose a reason for hiding this comment

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

Tested, working as expected.

@github-actions
Copy link

github-actions bot commented Aug 8, 2023

This pull request has conflicts, please rebase with master to resolve those before we can evaluate the pull request.

@GMishx
Copy link
Member

GMishx commented Aug 9, 2023

@dushimsam please rebase for merge.

Signed-off-by: dushimsam <dushsam@gmail.com>
@dushimsam
Copy link
Contributor Author

Done

@GMishx GMishx merged commit 0e474a8 into fossology:master Aug 28, 2023
14 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
GSOC-23 Label to tag pull request which are part of the GSOC 2023 ready
Projects
None yet
Development

Successfully merging this pull request may close these issues.

License File View - Bulk History
2 participants