Skip to content

Search: document attribute-level access control and Search Strategy API #152#140

Open
fractal3000 wants to merge 2 commits into
release_3from
feature/4200-search-attribute-access-breaking-change
Open

Search: document attribute-level access control and Search Strategy API #152#140
fractal3000 wants to merge 2 commits into
release_3from
feature/4200-search-attribute-access-breaking-change

Conversation

@fractal3000

@fractal3000 fractal3000 commented Jun 17, 2026

Copy link
Copy Markdown
Contributor

#152

Changes

  • whats-new/release-3.0.adoc
    • New Features: new entry "Search Access Control by Attributes".
    • Breaking Changes: new "Search" subsection (attribute read permissions, SearchStrategy API
      change, SearchUtils removal).
  • search/search-api.adoc — "Access Control and Pagination" updated to mention that attribute
    permissions are now applied when building the query.
  • search/search-in-ui.adoc — "Custom Search Strategies" rewritten for the new API: extend
    AbstractOpenSearchStrategy / AbstractElasticSearchStrategy and build the query via the platform
    QueryConfigurer so the search scope and security policies are applied. Added a NOTE warning against
    configuring the request builder directly.
  • search/examples/search-ex1/.../CustomOpenSearchSearchStrategy.java — example corrected to the
    canonical approach.

Actual since v2.7.0

…PI #4200

release-3.0.adoc:
- New Features: "Search Access Control by Attributes"
- Breaking Changes: "Search" (attribute-level access, SearchStrategy API, SearchUtils removal)

search-api.adoc:
- "Access Control and Pagination" updated with the attribute-level step

search-in-ui.adoc + search-ex1:
- "Custom Search Strategies" updated to the new API: extend AbstractOpenSearchStrategy /
  AbstractElasticSearchStrategy and build the query via the platform QueryConfigurer so that
  the search scope and security policies are applied

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@fractal3000 fractal3000 force-pushed the feature/4200-search-attribute-access-breaking-change branch from b30d9ef to 6c553f2 Compare June 17, 2026 13:21
include::example$/search-ex1/src/main/java/com/company/demo/service/CustomOpenSearchSearchStrategy.java[tags=strategy]
----
<1> The base class is initialized with the platform-specific query configurer (`OpenSearchQueryConfigurer` or `ElasticSearchQueryConfigurer`), available as the `queryConfigurer` field.
<2> `getName()` returns a unique strategy name used to select the strategy.

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add something about configureRequest method

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done

@fractal3000 fractal3000 changed the title Search: document attribute-level access control and Search Strategy API #4200 Search: document attribute-level access control and Search Strategy API #152 Jun 25, 2026
- search-in-ui.adoc + example: describe the configureRequest(SearchRequestContext)
  method explicitly (review comment), with a dedicated callout
- release-3.0.adoc: attribute-level access is a 2.7 feature, not 3.0 — keep only the
  3.0 removal of the API deprecated in 2.7 (#4866)
- search-api.adoc: mark the attribute-level behavior as "Since Jmix 2.7"

Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
@knstvk knstvk self-assigned this Jun 26, 2026
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.

Search: document attribute-level access control and Search Strategy API

3 participants