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

Add User Approval APIs #260

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

Add User Approval APIs #260

wants to merge 8 commits into from

Conversation

SenuDyl
Copy link

@SenuDyl SenuDyl commented Mar 1, 2025 •
edited
Loading

Purpose

Add user approval APIs to facilitate approval-based workflows. Resolves issue: wso2/product-is#23374

Goals

  • Provide a set of APIs to manage approval tasks related to user actions.
  • Allow relevant parties to retrieve, approve, reject, and track approval requests.
  • Allow integration with simple workflow engine instead of BPS engine.

Approach

User Approval API Specification

https://app.swaggerhub.com/apis/SenuriMallikarachchi/User-Approvals/1.0.0

User stories

Summary of user stories addressed by this change>

Release note

Brief description of the new feature or bug fix as it will appear in the release notes

Documentation

Link(s) to product documentation that addresses the changes of this PR. If no doc impact, enter “N/A” plus brief explanation of why there’s no doc impact

Training

Link to the PR for changes to the training content in https://github.com/wso2/WSO2-Training, if applicable

Certification

Type “Sent” when you have provided new/updated certification questions, plus four answers for each question (correct answer highlighted in bold), based on this change. Certification questions/answers should be sent to [email protected] and NOT pasted in this PR. If there is no impact on certification exams, type “N/A” and explain why.

Marketing

Link to drafts of marketing content that will describe and promote this feature, including product page changes, technical articles, blog posts, videos, etc., if applicable

Automation tests

  • Unit tests

    Code coverage information

  • Integration tests

    Details about the test cases and coverage

Security checks

Samples

Provide high-level details about the samples related to this feature

Related PRs

List any other related PRs

Migrations (if applicable)

Describe migration steps and platforms on which migration has been tested

Test environment

List all JDK versions, operating systems, databases, and browser/versions on which this feature/fix was tested

Learning

Describe the research phase and any blog posts, patterns, libraries, or add-ons you used to solve the problem.

@CLAassistant
Copy link

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

sadilchamishka
sadilchamishka reviewed Mar 1, 2025
View reviewed changes
....carbon.identity.api.user.approval/org.wso2.carbon.identity.api.user.approval.common/pom.xml
<parent>
<artifactId>org.wso2.carbon.identity.api.user.approval</artifactId>
<groupId>org.wso2.carbon.identity.user.api</groupId>
<version>1.3.59-SNAPSHOT</version>
Copy link
Contributor

Choose a reason for hiding this comment

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

The artifact version might get increased when we are going to merge this PR. At that time, let's remember to update the version.

....carbon.identity.api.user.approval/org.wso2.carbon.identity.api.user.approval.common/pom.xml Outdated

</dependencies>

</project>
Copy link
Contributor

Choose a reason for hiding this comment

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

Add new line to the end of file.

...o2/carbon/identity/rest/api/user/approval/v1/core/factories/ApprovalEventServiceFactory.java
import org.wso2.carbon.identity.workflow.engine.ApprovalEventService;

public class ApprovalEventServiceFactory {
private static final ApprovalEventService SERVICE;
Copy link
Contributor

Choose a reason for hiding this comment

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

Add new line. Follow for the other classes also.

.../src/main/java/org/wso2/carbon/identity/rest/api/user/approval/v1/impl/MeApiServiceImpl.java Outdated
@Override
public Response getApprovalTaskInfo(String taskId) {

// do some magic!
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
// do some magic!

@nilasini
Copy link
Contributor

nilasini commented Mar 6, 2025

@SenuDyl Shall we update the PR description with the public git issue?

@SenuDyl SenuDyl changed the title Add user approval APIs Update user approval APIs to support Simple Workflow Engine Integration Mar 9, 2025
@SenuDyl SenuDyl changed the title Update user approval APIs to support Simple Workflow Engine Integration Update User Approval APIs to Support Simple Workflow Engine Integration Mar 9, 2025
@SenuDyl SenuDyl changed the title Update User Approval APIs to Support Simple Workflow Engine Integration Add User Approval APIs Mar 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sadilchamishka sadilchamishka sadilchamishka left review comments

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
4 participants
@SenuDyl @CLAassistant @nilasini @sadilchamishka