Commit 219a896c authored by LE GAC Renaud's avatar LE GAC Renaud
Browse files

Update InvenioStore to improve doc string.

parent e7bc7fe6
......@@ -70,7 +70,13 @@ class InvenioStore(object):
Keyword Args:
The keyword arguments are those of the invenio web interface.
Details are in https://cds.cern.ch/help/hacking/search-engine-api.
Details are in https://inspirehep.net/help/hacking/search-engine-api
Examples how to use the invenio API:
https://inspirehep.net/info/hep/api?ln=fr#json_fnames
List of keyword in the JSON record:
https://github.com/inspirehep/invenio/blob/prod/modules/bibfield/etc/atlantis.cfg
req (str):
mod_python Request class instance.
......@@ -302,7 +308,16 @@ class InvenioStore(object):
def get_ids(self, **kwargs):
"""Return a list of *record id* matching search criteria.
Search criteria are defined by the keywords arguments:
Search criteria are defined by the keywords arguments.
The complete list of keyword arguments can be found at
https://inspirehep.net/help/hacking/search-engine-api
Examples how to use the invenio API:
https://inspirehep.net/info/hep/api?ln=fr#json_fnames
List of keyword in the JSON record:
https://github.com/inspirehep/invenio/blob/prod/modules/bibfield/etc/atlantis.cfg
Keyword Args:
cc (str):
......@@ -362,9 +377,6 @@ class InvenioStore(object):
("a" all of the words, "o" any of the words, "e" exact
phrase, "p" partial phrase, "r" regular expression).
The complete list of keyword arguments can be found at
http://invenio-demo.cern.ch/help/hacking/search-engine-api.
Returns:
list:
* A list of numbers.
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment