From fb8a4ea7083b598512f2d3118dbf41331b0fae0a Mon Sep 17 00:00:00 2001 From: miker Date: Wed, 28 Jul 2010 14:37:00 +0000 Subject: [PATCH] documentation for facet value retrieve method git-svn-id: svn://svn.open-ils.org/ILS/trunk@17048 dcc99617-32d9-48b4-a31d-7c20da2025e4 --- .../src/perlmods/OpenILS/Application/Search/Biblio.pm | 19 ++++++++++++++++++- 1 file changed, 18 insertions(+), 1 deletion(-) diff --git a/Open-ILS/src/perlmods/OpenILS/Application/Search/Biblio.pm b/Open-ILS/src/perlmods/OpenILS/Application/Search/Biblio.pm index 07a3dbfdf..4e94693c4 100644 --- a/Open-ILS/src/perlmods/OpenILS/Application/Search/Biblio.pm +++ b/Open-ILS/src/perlmods/OpenILS/Application/Search/Biblio.pm @@ -1320,7 +1320,24 @@ sub retrieve_cached_facets { __PACKAGE__->register_method( method => "retrieve_cached_facets", - api_name => "open-ils.search.facet_cache.retrieve" + api_name => "open-ils.search.facet_cache.retrieve", + signature => { + desc => 'Returns facet data derived from a specific search based on a key '. + 'generated by open-ils.search.biblio.multiclass.staged and friends.', + params => [ + { + desc => "The facet cache key returned with the initial search as the facet_key hash value", + type => 'string', + } + ], + return => { + desc => 'Two level hash of facet values. Top level key is the facet id defined on the config.metabib_field table. '. + 'Second level key is a string facet value. Datum attached to each facet value is the number of distinct records, '. + 'or metarecords for a metarecord search, which use that facet value and are visible to the search at the time of '. + 'facet retrieval. These counts are calculated for all superpages that have been checked for visibility.', + type => 'object', + } + } ); -- 2.11.0