Dev: Define API for Metadata search

asclepias / asclepias-broker

Asclepias broker

https://asclepias-broker.readthedocs.io/en/latest/

MIT License

13 stars 12 forks source link

Dev: Define API for Metadata search #98

Closed mubdi closed 3 years ago

mubdi commented 3 years ago

Determine RESTful API for metadata citation search

mubdi commented 3 years ago

@mattiaswangblad has created a new METADATA REST API endpoint which can be tested on the dev implementation: https://asclepias-broker-node.eastus.cloudapp.azure.com/metadata?journal=the%20Astrophysical%20Journal&year=2015&keyword=astrometry

Currently accepted metadata parameters to search over are Journal Keywords, Journal Name, and Publication Year.

mubdi commented 3 years ago

Some details on Metadata on aggregation: https://www.elastic.co/guide/en/elasticsearch/reference/current/search-aggregations.html#add-metadata-to-an-agg

mubdi commented 3 years ago

@mattiaswangblad has implemented a metadata aggregation search, which returns the aggregation of the software where papers cited have specific keywords or publication years, etc. Remaining todos:

[x] Implement Pagination for the aggregations
[ ] Clean metadata resulting json

For the latter, @slint -- do you have any recommendations of how to capture the result json from elasticsearch to reformat it before invenio adds the pagniation/links to the json?

mubdi commented 3 years ago

Metadata output json is really a result from ElasticSearch, so let's not change that for now.