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

Simplify interface for getting user response from template #7952

Closed
freddidierRTE opened this issue Feb 10, 2025 · 0 comments · Fixed by #7958
Closed

Simplify interface for getting user response from template #7952

freddidierRTE opened this issue Feb 10, 2025 · 0 comments · Fixed by #7958
Assignees
Labels
Enhancement New feature

Comments

@freddidierRTE
Copy link
Contributor

freddidierRTE commented Feb 10, 2025

Today to define the user response opfab uses a register method to get data from the template

The structure of the response is :

{
valid: boolean
errorMessage: string
responseCardData: the data field of the child card
actions: The actions field value for the response card. This field is optional.
responseState: The state field value for the response card. This field is optional (default value is defined in the state process definition).
publisher: The publisher field value for the response card. This field is optional (default value is the first current user entity that is allowed to respond).
}

To ease the use and understanding of the API , it should now be

{
valid: boolean
errorMessage: string
responseCard:
     data : the data field of the child card
     actions: The actions field value for the response card. This field is optional.
     state: The state field value for the response card. This field is optional (default value is defined in the state process definition).
     publisher: The publisher field value for the response card. This field is optional (default value is the first current user entity that is allowed to respond).
}

Old structure will still be useable but deprecated

@freddidierRTE freddidierRTE added the Enhancement New feature label Feb 10, 2025
@freddidierRTE freddidierRTE self-assigned this Feb 10, 2025
freddidierRTE added a commit that referenced this issue Feb 11, 2025
freddidierRTE added a commit that referenced this issue Feb 11, 2025
freddidierRTE added a commit that referenced this issue Feb 11, 2025
freddidierRTE added a commit that referenced this issue Feb 11, 2025
@github-project-automation github-project-automation bot moved this from In progress to Done in OperatorFabric Release 4.7 Feb 12, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement New feature
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant