operatorfabric-core Remove deprecated API method opfab.currentCard.getEntityUsedForUserRe…

In release notes :
- In chapter : Features
- Text : #6837 : Remove deprecated API method opfab.currentCard.getEntityUsedForUserResponse

Summary by CodeRabbit

New Features
- Enhanced documentation for the frontend API, improving clarity on various methods and functionalities.
- Introduction of new methods for handling user interactions and responses in the CurrentCard and CurrentUserCard APIs.
- Added input sanitization method to enhance security.
Bug Fixes
- Deprecated and removed outdated API methods, streamlining user response handling.
Documentation
- Updated migration guide for version 4.5.0, detailing significant changes including library updates and configuration modifications.

Oct 03 '24 15:10 vlo-rte

Walkthrough

The changes in this pull request primarily involve updates to the documentation and implementation of several APIs related to the frontend system. Key modifications include the introduction of new functions in the CurrentCard and CurrentUserCard APIs, the deprecation and removal of outdated methods, and enhancements to the migration guide for version 4.5.0. Additionally, the OpfabAPIService class has been updated to streamline API initialization and improve usability.

Changes

File Path	Change Summary
`src/docs/asciidoc/reference_doc/ui_api.adoc`	Added multiple functions to `CurrentCard` and `CurrentUserCard` APIs; deprecated `getEntityUsedForUserResponse`.
`src/docs/asciidoc/resources/migration_guide_to_4.5.adoc`	Updated migration guide to reflect changes from version 4.4.X to 4.5.0, including Docker Compose upgrade and API method removal.
`ui/main/src/app/business/services/opfabAPI.service.ts`	Removed deprecated method `getEntityUsedForUserResponse` and added `getEntitiesUsableForUserResponse`; updated API initialization methods.
`ui/main/src/assets/js/opfab.js`	Removed method `getEntityUsedForUserResponse` from `opfab.currentCard`.
`ui/main/src/app/modules/card/components/card-body/card-body.component.ts`	Updated `setOpfabApiVariables` method to remove assignment of deprecated property.

Possibly related issues

opfab/operatorfabric-core#6837: This PR addresses the removal of the deprecated API method opfab.currentCard.getEntityUsedForUserResponse, which is directly mentioned in the issue.

Possibly related PRs

#7256: The removal of the deprecated getEntityUsedForUserResponse method and its replacement with getEntitiesUsableForUserResponse in the main PR is directly related to the changes in the OpfabAPIService class in the retrieved PR, which also removes the deprecated method and integrates the new one.

Poem

🐇 In the garden where APIs bloom,
New functions sprout, dispelling the gloom.
Old paths are cleared, deprecated ways,
A fresh migration guides our days.
With each update, the code hops along,
In the world of tech, we all belong! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json