Skip to content

[doc issue] Improve Documentation on @cds.search Annotation for Search Configuration in Fiori Elements #190

Open
@guilhermepioner

Description

@guilhermepioner

Issue description

Hello!

I'd like to raise an issue concerning the documentation gap related to the use of the @cds.search annotation within the context of configuring search functionality in Fiori Elements applications.

While the SAP UI5 documentation extensively covers how filters are implemented and utilized in Fiori Elements applications, there is considerably less information available on managing search functionality, particularly regarding the configuration and customization of searchable properties.

This was a recent problem I encountered alongside my colleagues while learning Fiori Elements for a new project, where we spent a long time trying to limit which properties the Search Field should filter on a List Report Page. We were actually creating an extension to achieve this behavior through a custom field until I randomly discovered this file from a CAP example that uses the @cds.search annotation.

The only reference I could find about the annotation was here in CAPire's official documentation.

Below, I linked a page in the UI5 documentation which I believe could incorporate this content, but perhaps creating a new one under the parent topic Configuring Filter Bars would be a better approach.

Feedback Type (Optional)

content gaps

Page Title on SAP Help Portal (prefilled)

Enabling the Search Function

Page URL on SAP Help Portal (prefilled)

https://sapui5.hana.ondemand.com/sdk/#/topic/3cdebeebb04b4205908140242c9d6817

Metadata

Metadata

Assignees

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions