Skip to content

Update working-with-ui-annotations-83c89cc.md #197

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

Draft
wants to merge 1 commit into
base: main
Choose a base branch
from

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.
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!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants