Releases: CDRH/api
Releases · CDRH/api
v2.0.0 - Nested Bucket Aggregations & Query Functionality
What's New
api_versionadded to all responseresobjects- Support for Elasticsearch 8.5+
- User/password basic authentication support when credentials present
- Better support for nested fields
- Support for nested bucket aggregations, matching a nested value on another
nested value. For example,person.name[person.role#judge]will return
all names of persons whererole="judge" track total hitsoption added to ES queries, to return counts of search
results higher than 10000- Added support for aggregating buckets by normalized keyword and returning
thetop_hitsfirst document result for a non-normalized display. Internal logic
has been changed because of nested fields, this may cause subtle differences
in how facet labels are displayed - Changes response format of
facetskey. Not only is the response format
itself different, but there may be fewer facets returned since matching
normalized values are combined
Migration
- Add nested facets as described above, if desired
- Orchid apps that connect to the API should use
facet_limitinstead offacet_numin options - In the config files of your Datura repos, (
private.ymlorpublic.yml, set
the api to"api_version": "2.0"to take advantage of new bucket aggregation
functionality (or"api_version": "1.0"for legacy repos that have not been
updated for the new schema). Please note that a running API index can only use
one ES index at a time, and each ES index is restricted to one version of the
schema. See new schema (2.0)
documentation. - Connect to Elasticsearch 8.5 or later
- If you are using ES with security enabled, you must configure credentials
with Rails in the API repo. See
https://guides.rubyonrails.org/v6.1/security.html. To configure with VSCode
editor runEDITOR="code --wait" rails credentials:editand add to the
secrets file and then close the window to save.
Do not commitconfig/master.key(it should be in.gitignore)
See the changelog for full details.
Full Commit History: v1.0.5...v2.0.0
v1.0.5 - API v1 on Ruby 3.1.6, Rails 6.1.7
Patch release v1.0.5 with Ruby 3.1.6, Rails 6.1.7
Version 1.0.4 - Updates & license
Changed
- Updated Ruby version, gems (which addresses mimemagic dependency problem), and Puma
- added license
Added
- Documentation on facets and highlighting
Version 1.0.3 - Minor updates to gems
Patch update for rails and other gems
Version 1.0.2 - escapes and sorting
Fixed
- question mark and asterisk behavior in queries
- order of expected, actual in tests
- sort behavior for relevancy
Added
- support for multivalued and nested field sorting
- documentation moved back into apium from henbit location in order to version it with software
Changed
- ruby, rails, and other gem versions
Version 1.0.1
- Update Ruby to 2.5.3
- Update Rails to 2.5.1
- Update gems with recent vulnerability reports (loofah, rack)
- Move version to an initializer
Version 1 Launch
Merge pull request #77 from CDRH/update bumps rails, other gems to new versions