[open-ils-commits] [GIT] Evergreen ILS branch master updated. fed1f319bfa81c974067b1f84872e43de0f4d4b2

[Evergreen Git]

This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "Evergreen ILS".

The branch, master has been updated
       via  fed1f319bfa81c974067b1f84872e43de0f4d4b2 (commit)
       via  19a1b40771247119cdf8c655a96647d580a78922 (commit)
      from  0e80495da765d9072b61df119f0ab19646421000 (commit)

Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.

- Log -----------------------------------------------------------------
commit fed1f319bfa81c974067b1f84872e43de0f4d4b2
Merge: 19a1b40 0e80495
Author: Jane Sandberg <sandbej at linnbenton.edu>
Date:   Tue Apr 10 16:30:54 2018 -0700

    Merge branch 'master' of git.evergreen-ils.org:Evergreen


commit 19a1b40771247119cdf8c655a96647d580a78922
Author: Jane Sandberg <sandbej at linnbenton.edu>
Date:   Tue Apr 10 16:30:39 2018 -0700

    Docs: adding some basic info about getting data from opensearch
    
    Signed-off-by: Jane Sandberg <sandbej at linnbenton.edu>

diff --git a/docs/development/data_opensearch.adoc b/docs/development/data_opensearch.adoc
new file mode 100644
index 0000000..102c90a
--- /dev/null
+++ b/docs/development/data_opensearch.adoc
@@ -0,0 +1,26 @@
+Using Opensearch as a developer
+===============================
+
+Introduction
+------------
+
+Evergreen responds to OpenSearch requests. This can be a good way to get
+search results delivered in a format that you prefer.
+
+Throughout this section, replace `<hostname>` with the domain or subdomain
+of your Evergreen installation to try these examples on your own system.
+
+Opensearch queries will be in the format
+`http://<hostname>/opac/extras/opensearch/1.1/-/html-full?searchTerms=item_type(r)&searchClass=keyword&count=25`
+
+In this example,
+
+* html-full is the format you would like.  html-full is a good view for troubleshooting your query.
+* searchTerms is a url-encoded search query.  You can use limiters in the `limiter(value)` format.
+For example, you can use a query like `item_lang(spa)`
+* count is the number of results per page.  The default is 10, and the maximum is 25.
+
+Other options include:
+
+* searchSort and searchSortDir, which can be used to display the results in a different order (e.g. for an RSS feed).
+
diff --git a/docs/root.adoc b/docs/root.adoc
index 09553e4..f29673a 100644
--- a/docs/root.adoc
+++ b/docs/root.adoc
@@ -540,6 +540,8 @@ include::development/data_supercat.adoc[]
 
 include::development/data_unapi.adoc[]
 
+include::development/data_opensearch.adoc[]
+
 // Return to normal title levels.
 :leveloffset: 0
 
diff --git a/docs/root_integrations.adoc b/docs/root_integrations.adoc
index 553d130..7d51c76 100644
--- a/docs/root_integrations.adoc
+++ b/docs/root_integrations.adoc
@@ -30,6 +30,8 @@ include::development/data_supercat.adoc[]
 
 include::development/data_unapi.adoc[]
 
+include::development/data_opensearch.adoc[]
+
 include::admin/phonelist.adoc[]
 
 

-----------------------------------------------------------------------

Summary of changes:
 docs/development/data_opensearch.adoc |   26 ++++++++++++++++++++++++++
 docs/root.adoc                        |    2 ++
 docs/root_integrations.adoc           |    2 ++
 3 files changed, 30 insertions(+), 0 deletions(-)
 create mode 100644 docs/development/data_opensearch.adoc


hooks/post-receive
-- 
Evergreen ILS