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

[Extensions] Delete Job Details API #314

Open
vibrantvarun opened this issue Feb 13, 2023 · 11 comments
Open

[Extensions] Delete Job Details API #314

vibrantvarun opened this issue Feb 13, 2023 · 11 comments
Assignees
Labels
CCI College Contributor Initiative PRs enhancement New feature or request good first issue Good for newcomers

Comments

@vibrantvarun
Copy link
Member

Is your feature request related to a problem? Please describe.
Create a Delete Job Details Rest API with documentId as a input parameter. It will help to delete job details objects with issues with the help of API

Describe the solution you'd like
API input and output

Input: documentId = String
Output: status of the operation (DELETED or NOT_FOUND)

Prerequisites

  1. Have knowledge of how actionlisteners work to make async calls
  2. Have knowledge of the code-flow of RestGetJobDetailsAction

Additional context

  1. create RestDeleteJobDetailsAction in path org.opensearch.jobscheduler.action
  2. RestDeleteJobDetailsAction should extend abstract class BaseRestHandler
  3. Override routes() and prepareRequest() method in RestDeleteJobDetailsAction class
  4. Define two static strings in class
  5. public static final String DELETE_JOB_DETAILS_ACTION = "delete_job_details_action";
  6. public static final String DOCUMENT_ID = "document_id";
  7. In routes method return a list of route with given Route below
    new Route(DELETE, String.format(Locale.ROOT, "%s/%s/{%s}", JobSchedulerPlugin.JS_BASE_URI, "_delete_job_details", DOCUMENT_ID))
  8. Override getName() method and return DELETE_JOB_DETAILS_ACTION
  9. Create a public constructor in RestDeleteJobDetailsAction with JobDetailsService as argument and initialize the local variable
public RestDeleteJobDetailsAction(JobDetailsService jobDetailsService){
this.jobDetailsService=jobDetailsService;
}
  1. call jobDetailsService.deleteJobDetails
  2. Return channel response
@vibrantvarun vibrantvarun added enhancement New feature or request good first issue Good for newcomers untriaged labels Feb 13, 2023
@vibrantvarun vibrantvarun changed the title [FEATURE/EXTENSION] Delete Job Details API [FEATURE/EXTENSIONS] Delete Job Details API Feb 13, 2023
@joshpalis joshpalis changed the title [FEATURE/EXTENSIONS] Delete Job Details API [Extensions] Delete Job Details API Feb 13, 2023
@joshpalis joshpalis removed their assignment Feb 13, 2023
@joshpalis joshpalis removed their assignment Feb 13, 2023
@MadinaBonuAlisherova
Copy link

Hi, I would like to work on this issue, could you please assign this one to me?

@minalsha minalsha added the CCI College Contributor Initiative PRs label Mar 29, 2023
@minalsha
Copy link

Thank you for contributing to this issue @MadinaBonuAlisherova . Please do reach out with any questions or help. Thanks

@minalsha
Copy link

Hi @MadinaBonuAlisherova , do you need any help? How is the progress for this issue coming along?

1 similar comment
@minalsha
Copy link

Hi @MadinaBonuAlisherova , do you need any help? How is the progress for this issue coming along?

@vibrantvarun
Copy link
Member Author

Hi @MadinaBonuAlisherova Do you need any help from our side? If you need then we can schedule a session with you.

Thanks

@MadinaBonuAlisherova
Copy link

Hi, @vibrantvarun, I guess no help is needed, but can we schedule a session on Thursdays?

@vibrantvarun
Copy link
Member Author

Hi @MadinaBonuAlisherova Can you please join the office hours on coming Wednesday. I would like to have a look and discuss your update.

@MadinaBonuAlisherova
Copy link

I am still working on this matter, but progress has slowed down due to my involvement in other tasks. I plan to submit a pull request either today or tomorrow, and I would greatly appreciate it if you could review it and provide feedback if im on the right tracck or not. I will do my best to ensure consistency throughout.

@MadinaBonuAlisherova
Copy link

@vibrantvarun @joshpalis Can we have a call today if you are available?

@joshpalis
Copy link
Member

joshpalis commented Apr 26, 2023

@MadinaBonuAlisherova Sure, I am currently in the office hours chime room, meeting ID : 4353 34 7230

@minalsha minalsha linked a pull request Apr 26, 2023 that will close this issue
5 tasks
@nandiniverma08
Copy link

@vibrantvarun Is this issue closed ?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CCI College Contributor Initiative PRs enhancement New feature or request good first issue Good for newcomers
Projects
Status: 📦 Backlog
Development

Successfully merging a pull request may close this issue.

5 participants