OpenBankProject / OpenBankProject/OBP-API
elasticSearchWarehouse: Specify esIndex instead of esType
Nobody has claimed this yet.
- Dominant language
- Scala
- Stars
- 1.7k
- Forks
- 482
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 15
Description
Last year, we had each data file in its own type in one index. So the the helper esType was introduced to API method elasticSearchWarehouse to limit the search to a specific type.
Alas, we found out that, when managing indices, e.g. changed import data, deleting types is not easily possible in Elasticsearch. So this year, we are going to store each data file in its own index (and always in type default). Hence it would be nicer for the user to be able to specify esIndex in the simple query.
For security reasons, the index provided by the user should be matched against the indices in the property es.warehouse.index to prevent searches in 'private' indices.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start at the elasticSearchWarehouse API method and inspect how the esType parameter and es.warehouse.index property are currently used. Add support for an esIndex query value while restricting it to configured warehouse indices; done means permitted indices can be searched and private indices cannot be selected.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- elasticsearch, scala
- Domain
- api, backend, search, security
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100