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.

Sign up for GitHub

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

Jump to bottom

Rest API: Implement missing endpoints for Content Import Job Resource #30874

Closed
Tracked by #30550
valentinogiardino opened this issue Dec 6, 2024 · 1 comment · Fixed by #30896
Closed
Tracked by #30550

Rest API: Implement missing endpoints for Content Import Job Resource #30874

valentinogiardino opened this issue Dec 6, 2024 · 1 comment · Fixed by #30896
Labels
Doc : Needs Doc Merged QA : Passed Internal Release : 24.12.10 Team : Scout Type : Task

Comments

@valentinogiardino
Copy link
Contributor

valentinogiardino commented Dec 6, 2024 •
edited
Loading

Parent Issue

#30550

Task

Implement the endpoints for:

  1. List Import Jobs
  • Endpoint: GET /content/_import
  • Parameters:
    • page: Page number
    • size: Items per page
  • Purpose: Lists all enqueued jobs with pagination
  1. List Import Jobs
  • Endpoint: GET /content/_import
  • Parameters:
    • page: Page number
    • size: Items per page
  • Purpose: Lists all enqueued jobs with pagination
  1. List Active Import Jobs
  • Endpoint: GET /content/_import/active
  • Parameters:
    • page: Page number
    • size: Items per page
  • Purpose: Lists all active enqueued jobs with pagination
  1. List Completed Import Jobs
  • Endpoint: GET /content/_import/completed
  • Parameters:
    • page: Page number
    • size: Items per page
  • Purpose: Lists all completed enqueued jobs with pagination
  1. List Completed Import Jobs
  • Endpoint: GET /content/_import/failed
  • Parameters:
    • page: Page number
    • size: Items per page
  • Purpose: Lists all failed enqueued jobs with pagination
  1. List Canceled Import Jobs
  • Endpoint: GET /content/_import/canceled
  • Parameters:
    • page: Page number
    • size: Items per page
  • Purpose: Lists all canceled enqueued jobs with pagination
  1. List Successful Import Jobs
  • Endpoint: GET /content/_import/successful
  • Parameters:
    • page: Page number
    • size: Items per page
  • Purpose: Lists all successful enqueued jobs with pagination
  1. List Import Jobs
  • Endpoint: GET /content/_import
  • Parameters:
    • page: Page number
    • size: Items per page
  • Purpose: Lists all enqueued jobs with pagination
  1. Cancel Job
  • Endpoint: POST /content/_import/{jobId}/cancel
  • Parameters: jobId
  • Purpose: Cancels a running import job

Proposed Objective

Core Features

Proposed Priority

Priority 2 - Important

Acceptance Criteria

No response

External Links... Slack Conversations, Support Tickets, Figma Designs, etc.

No response

Assumptions & Initiation Needs

No response

Quality Assurance Notes & Workarounds

No response

Sub-Tasks & Estimates

No response
@valentinogiardino valentinogiardino self-assigned this Dec 6, 2024
@valentinogiardino valentinogiardino mentioned this issue Dec 6, 2024
Open
@valentinogiardino valentinogiardino moved this from New to In Progress in dotCMS - Product Planning Dec 6, 2024
valentinogiardino added a commit that referenced this issue Dec 6, 2024
@valentinogiardino
#30874 update schema params
080419d
valentinogiardino added a commit that referenced this issue Dec 6, 2024
@valentinogiardino
#30874 add ResponseEntityJobPaginationResultView
7fe33a7
valentinogiardino added a commit that referenced this issue Dec 6, 2024
@valentinogiardino
#30874 add methods in jobQueue
fcb9f66
valentinogiardino added a commit that referenced this issue Dec 6, 2024
@valentinogiardino
#30874 add methods in helper
077d6f6
valentinogiardino added a commit that referenced this issue Dec 6, 2024
@valentinogiardino
#30874 add endpoints
e96f2ad
valentinogiardino added a commit that referenced this issue Dec 9, 2024
@valentinogiardino
#30874 add integration tests
986fd48
valentinogiardino added a commit that referenced this issue Dec 9, 2024
@valentinogiardino
#30874 add postman tests
364dffb
valentinogiardino added a commit that referenced this issue Dec 9, 2024
@valentinogiardino
#30874 fix postman tests
55da0ce
valentinogiardino added a commit that referenced this issue Dec 9, 2024
@valentinogiardino
#30874 update it
1db3a9e
@valentinogiardino valentinogiardino linked a pull request Dec 9, 2024 that will close this issue
Rest API: Implement missing endpoints for content import job resource #30874 #30896
Merged
3 tasks
@github-actions GitHub Actions
Copy link

github-actions bot commented Dec 9, 2024

PRs:

@valentinogiardino valentinogiardino moved this from In Progress to In Review in dotCMS - Product Planning Dec 9, 2024
valentinogiardino added a commit that referenced this issue Dec 9, 2024
@valentinogiardino
#30874 add PostgresQueueIntegrationTest for getJobs
8ecfd84
valentinogiardino added a commit that referenced this issue Dec 9, 2024
@valentinogiardino
#30874 remove extra blank lines
7ffabed
valentinogiardino added a commit that referenced this issue Dec 9, 2024
@valentinogiardino
#30874 add javadoc
8540498
github-merge-queue bot pushed a commit that referenced this issue Dec 9, 2024
@valentinogiardino
Rest API: Implement missing endpoints for content import job resource #…
fc6ec2a 
…30874 (#30896)

### Proposed Changes

* Added methods to fetch content import jobs by statuses: completed,
canceled, failed, abandoned, and successful.
* Implemented functionality to list jobs with pagination for the
following statuses:
  - Active
  - Completed
  - Failed
  - Canceled
  - Successful
* Enhanced job queue management to support status-based filtering within
specific queues.
* Added a new `ResponseEntityJobPaginatedResultView` class for handling
paginated REST responses.
* Extended `ContentImportHelper` to support job fetching by status and
added support for job cancellation.
* Updated relevant classes and interfaces:
- `JobQueueManagerAPI` and `JobQueueManagerAPIImpl` to include new job
retrieval methods.
- `JobQueue` and `PostgresJobQueue` for filtering and retrieving jobs by
status.
  
### Checklist
- [x] Tests
- [x] Translations
- [x] Security Implications Contemplated

### Aditional info
This PR adds functionality for managing content import jobs, including
listing by status with pagination and the ability to cancel jobs.
@github-actions github-actions bot mentioned this issue Dec 9, 2024
Merged
3 tasks
@github-project-automation github-project-automation bot moved this from In Review to Internal QA in dotCMS - Product Planning Dec 9, 2024
@nollymar nollymar reopened this Dec 10, 2024
@github-project-automation github-project-automation bot moved this from Internal QA to Current Sprint Backlog in dotCMS - Product Planning Dec 10, 2024
@nollymar nollymar moved this from Current Sprint Backlog to Internal QA in dotCMS - Product Planning Dec 10, 2024
@jgambarios jgambarios self-assigned this Dec 10, 2024
@jgambarios jgambarios moved this from Internal QA to Done in dotCMS - Product Planning Dec 10, 2024
@jgambarios jgambarios removed their assignment Dec 10, 2024
@nollymar nollymar moved this from Done to QA - Backlog in dotCMS - Product Planning Dec 10, 2024
@nollymar nollymar moved this from QA - Backlog to Done in dotCMS - Product Planning Jan 10, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Doc : Needs Doc Merged QA : Passed Internal Release : 24.12.10 Team : Scout Type : Task
Projects
dotCMS - Product Planning
Status: Done
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Rest API: Implement missing endpoints for content import job resource #30874 dotCMS/core
3 participants
@jgambarios @nollymar @valentinogiardino