Project

General

Profile

Actions

Feature #2495

closed

API: Simple search endpoint

Added by Bernhard Koschiček-Krombholz 9 months ago. Updated 9 months ago.

Status:
Closed
Priority:
Normal
Category:
API
Target version:
Start date:
2025-03-25
Estimated time:

Description

Currently, the search for entities can be quite complex. For easy access to a simple search by name function for external websites (e.g. presentation sites, APIs integration) or internal table filtering, a new endpoint is needed.
Since this endpoint will use the Endpoint() class, it has all entity parser options available, except the format parameter, which will be overwritten with an own slicker format using the result and pagination keys but has as results only very simple information.

Branch: feature/api/simple-search


Related issues 2 (1 open1 closed)

Related to OpenAtlas - Feature #2300: Load form tables dynamicallyIn ProgressKatharina Wünsche2025-01-27Actions
Related to OpenAtlas - Feature #2494: API: 0.4.7ClosedBernhard Koschiček-Krombholz2025-03-11Actions
Actions #1

Updated by Bernhard Koschiček-Krombholz 9 months ago

Actions #3

Updated by Bernhard Koschiček-Krombholz 9 months ago

A new endpoint, /search/<system_class>/<term>, has been added to search entity names for a given system class (or across all classes using 'all'). Currently, the search only matches terms starting with the provided input (e.g., "Hall" finds "Hallstatt" but not "Eingangshalle").

We need to define the expected search behavior in more detail. For example: What should happen if no exact match is found? Should we then perform a "like" search or other types of fuzzy matching?

Actions #4

Updated by Bernhard Koschiček-Krombholz 9 months ago

  • Description updated (diff)
Actions #5

Updated by Bernhard Koschiček-Krombholz 9 months ago

  • Status changed from Assigned to Closed

Implementation: First list all exact matches of the beginning of the entity name and after that are all fuzzy matches listed, where the term is in the entity name.
This should be enough for a quick search of entities right now.

Actions #6

Updated by Bernhard Koschiček-Krombholz 9 months ago

Actions #7

Updated by Alexander Watzinger 9 months ago

  • Target version changed from 8.12.0 to 8.11.0
Actions

Also available in: Atom PDF