Skip to content

Conversation

@hitesh-parmar
Copy link

@hitesh-parmar hitesh-parmar commented Aug 7, 2025

This commit delivers a comprehensive rewrite of the SAPUI5 SDK documentation topic "Working With UI Annotations." The updated version reflects current best practices and SAP's strategic direction, covering:

  • OData V2 support via both BOPF and RAP, including guidance on draft handling and annotations
  • OData V4 integration with RAP, showcasing in-place CDS annotations and behavior definitions
  • CAP model annotations, with examples using CSN/CDS syntax for Fiori elements
  • A detailed comparison of annotation types (in-place, ex-place, vocabulary-based)
  • Clear recommendations on using backend vs frontend annotations, with pros, cons, and use cases
  • Promotion of SAP Fiori tools for annotation management, previewing, and app generation
  • Migration guidance from legacy BOPF to RAP and Fiori elements

This update aims to support developers transitioning to RAP and CAP, improve annotation consistency, and encourage adoption of SAP Fiori tools for streamlined development workflows.

This commit delivers a comprehensive rewrite of the SAPUI5 SDK documentation topic "Working With UI Annotations." The updated version reflects current best practices and SAP's strategic direction, covering:

OData V2 support via both BOPF and RAP, including guidance on draft handling and annotations
OData V4 integration with RAP, showcasing in-place CDS annotations and behavior definitions
CAP model annotations, with examples using CSN/CDS syntax for Fiori elements
A detailed comparison of annotation types (in-place, ex-place, vocabulary-based)
Clear recommendations on using backend vs frontend annotations, with pros, cons, and use cases
Promotion of SAP Fiori tools for annotation management, previewing, and app generation
Migration guidance from legacy BOPF to RAP and Fiori elements
This update aims to support developers transitioning to RAP and CAP, improve annotation consistency, and encourage adoption of SAP Fiori tools for streamlined development workflows.
@cla-assistant
Copy link

cla-assistant bot commented Aug 7, 2025

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.

@OlMue
Copy link
Contributor

OlMue commented Aug 8, 2025

Hi Hitesh, thanks for your extensive contribution. I have tagged the SAP Fiori elements colleagues who will take a look. Could you please also sign the Contributor License Agreement? Thanks!

@hitesh-parmar
Copy link
Author

I am closing this PR as we decided to update the document via our SAP internal GitHub Repo.

@lfindlaysap lfindlaysap added the couldn't-be-clarified Closed because we didn't hear back. label Sep 26, 2025
@JannaLisa JannaLisa added contribution Valuable Contribution and removed couldn't-be-clarified Closed because we didn't hear back. labels Sep 26, 2025
@sap-doc-bot
Copy link

sap-doc-bot bot commented Sep 26, 2025

Thank you for your valuable content contribution, @hitesh-parmar! So that we can recognize your contribution in the SAP Community, please check your SAP Community user ID (this is a number) in your personal settings page and share it with us in a reply to this comment. Make sure you just include the number in the reply.

Your user ID is displayed as follows:

Change display name for User ID N

where N is your user ID. For example, 53 is the user ID of the user 'qmacro'.

Please note that we are currently refactoring our profile and badge system on the SAP Community, and will start assigning badges again when that's complete.

@JannaLisa JannaLisa added the type/content-gaps Something essential is missing in the documentation. label Sep 26, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

contribution Valuable Contribution SAP Fiori elements type/content-gaps Something essential is missing in the documentation.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants