Skip to main content
Back to overview

Detailed Information

Software name

jeap-opensearch-searchitem-api

Localised name

jeap-opensearch-searchitem-api

Application suite

jEAP

Short description

Spring MVC REST API and model for exposing indexed search items from OpenSearch in jEAP applications

Long description

jeap-opensearch-searchitem-api provides the SearchItemContainer model and a ready-to-use Spring MVC REST controller (SearchItemsController) for exposing indexed search items via a GET /index-api/searchitems endpoint. The endpoint accepts index_type, origin_id, and an optional origin_version query parameter, enforces role-based access control (role searchitem:read), and returns the SearchItem JSON body together with index-major-version and index-minor-version response headers. Applications implement the SearchItemsProvider interface to supply items from their OpenSearch indices. The multi-module layout separates the lightweight model (SearchItemContainer) from the Spring MVC controller so that providers can depend on the model without pulling in the full web layer.

Features

  • SearchItemContainer model pairing SearchItem with index version metadata
  • SearchItemsController REST endpoint with role-based access control
  • SearchItemsProvider SPI interface for application-specific item lookup
  • Separate model and API modules for lightweight dependency management

Development status

stable

Software type

library

Software version

2.31.0

Release date

10.09.2026

Platforms

web

Categories

application-development

License

Apache-2.0

Maintenance

Maintenance type:
internal
Contacts:
  • Federal Office of Information Technology, Systems and Telecommunication FOITT Email

Localisation

Localisation ready:
No
Available languages:
en

Publiccode.yml Version

0.5.0