diff --git a/api.html b/api.html index 81c205c..8dbb6d9 100644 --- a/api.html +++ b/api.html @@ -104,8 +104,10 @@

Navigation

  • after (str) – paths after this are iterated over. Defaults to “/”

  • stop (str) – iteration stops when the path is greater than or equal to this. Defaults to “~”

  • fetch_size (int) – The number of records to request from elasticsearch at a time.

  • -
  • exclude_phenomena (bool) – remove the bulky phenomena attribute from the record. Default is False.

  • -
  • item_type (str) – Item type for the records. Either “file”, “dir” or “link”. Defaults to all types.

  • +
  • exclude_phenomena (bool) – remove the bulky phenomena attribute from +the record. Default is False.

  • +
  • item_type (str) – Item type for the records. Either “file”, “dir” or “link”. +Defaults to all types.

  • Return iterator[dict]:
    @@ -129,7 +131,7 @@

    Navigation

    fbi_core.get_records_by_content(md5, filename=None, under=None, include_removed=False)
    -

    Get records with content that matches an md5. +

    Get records with content that matches an md5. Optionaly make it match a filename and a parent directory.