qa_server 0.1.99

data/app/validators/qa_server/scenario_validator.rb

@@ -0,0 +1,134 @@
+# ABSTRACT class providing common methods for running a scenario of any type.
+module QaServer
+  class ScenarioValidator
+    PASS = :good
+    FAIL = :bad
+    UNKNOWN = :unknown
+
+    VALIDATE_CONNECTION = :connection
+    VALIDATE_ACCURACY = :accuracy
+    ALL_VALIDATIONS = :all_validations
+    DEFAULT_VALIDATION_TYPE = VALIDATE_CONNECTION
+
+    # @param scenario [SearchScenario | TermScenario] the scenario to run
+    # @param status_log [ScenarioLogger] logger for recording test results
+    # @param validation_type [Symbol] the type of scenarios to run (e.g. VALIDATE_CONNECTION, VALIDATE_ACCURACY, ALL_VALIDATIONS)
+    def initialize(scenario:, status_log:, validation_type: DEFAULT_VALIDATION_TYPE)
+      @status_log = status_log
+      @scenario = scenario
+      @validation_type = validation_type
+    end
+
+    # Run a search scenario and log results.
+    def run
+      run_accuracy_scenario if accuracy_scenario? && validating_accuracy?
+      run_connection_scenario if connection_scenario? && validating_connections?
+    end
+
+    # Log the structure of the scenario without running the scenario test.
+    def log_without_running
+      log
+    end
+
+    private
+
+      # Log the structure of the scenario and status of a test run.
+      def log(status: nil, errmsg: nil, expected: nil, actual: nil, target: nil)
+        status_log.add(authority_name: authority_name,
+                       status: status,
+                       validation_type: scenario_validation_type,
+                       subauth: subauthority_name,
+                       service: service,
+                       action: action,
+                       url: url,
+                       error_message: errmsg,
+                       expected: expected,
+                       actual: actual,
+                       target: target)
+      end
+
+      def run_accuracy_scenario
+        # ABSTRACT - must be implemented by scenario validator for specific types
+      end
+
+      def run_connection_scenario
+        # ABSTRACT - must be implemented by scenario validator for specific types
+      end
+
+      # Runs the test in the block passed by the specific scenario type.
+      # @return [Symbol] :good (PASS) or :unknown (UNKNOWN) based on whether enough results were returned
+      def test_connection(min_expected_size: MIN_EXPECTED_SIZE, scenario_type_name:)
+        begin
+          results = yield if block_given?
+          actual_size = results.to_s.length
+          status = actual_size > min_expected_size ? PASS : UNKNOWN
+          errmsg = (status == PASS) ? '' : "#{scenario_type_name.capitalize} scenario unknown status; cause: Results actual size (#{actual_size} < expected size (#{min_expected_size})"
+          log(status: status, errmsg: errmsg)
+        rescue Exception => e
+          log(status: FAIL, errmsg: "Exception executing #{scenario_type_name} scenario; cause: #{e.message}")
+        end
+      end
+
+      def authority
+        scenario.authority
+      end
+
+      def authority_name
+        scenario.authority_name.upcase
+      end
+
+      def subauthority_name
+        scenario.subauthority_name
+      end
+
+      def service
+        scenario.service
+      end
+
+      def url
+        scenario.url
+      end
+
+      def action
+        # ABSTRACT - must be implemented by scenario validator for specific types
+      end
+
+      def status_log
+        @status_log
+      end
+
+      def scenario
+        @scenario
+      end
+
+      def validation_type
+        @validation_type
+      end
+
+      def scenario_validation_type
+        return VALIDATE_CONNECTION if connection_scenario?
+        return VALIDATE_ACCURACY if accuracy_scenario?
+        nil
+      end
+
+      def validating_connections?
+        return true if validation_type == VALIDATE_CONNECTION || validation_type == ALL_VALIDATIONS
+        false
+      end
+
+      def validating_accuracy?
+        return true if validation_type == VALIDATE_ACCURACY || validation_type == ALL_VALIDATIONS
+        false
+      end
+
+      def accuracy_scenario?
+        # ABSTRACT define in specific scenario type validator (i.e. TermScenarioValidator, SearchScenarioValidator)
+        false
+      end
+
+      def connection_scenario?
+        # ABSTRACT define in specific scenario type validator (i.e. TermScenarioValidator, SearchScenarioValidator)
+        false
+      end
+  end
+end

data/app/validators/qa_server/search_scenario_validator.rb

@@ -0,0 +1,84 @@
+require 'json'
+
+# This class runs a single search scenario and logs the results.
+module QaServer
+  class SearchScenarioValidator < ScenarioValidator
+    SEARCH_ACTION = 'search'.freeze
+
+    # @param scenario [SearchScenario] the scenario to run
+    # @param status_log [ScenarioLogger] logger for recording test results
+    # @param validation_type [Symbol] the type of scenarios to run (e.g. VALIDATE_CONNECTION, VALIDATE_ACCURACY, ALL_VALIDATIONS)
+    def initialize(scenario:, status_log:, validation_type: DEFAULT_VALIDATION_TYPE)
+      super
+    end
+
+    private
+
+      def action
+        SEARCH_ACTION
+      end
+
+      # Run the connection test and log results
+      def run_connection_scenario
+        test_connection(min_expected_size: scenario.min_result_size, scenario_type_name: 'search') do
+          authority.search(scenario.query,
+                           subauth: scenario.subauthority_name,
+                           replacements: scenario.replacements)
+        end
+      end
+
+      # Run the accuracy test and log results
+      def run_accuracy_scenario
+        test_accuracy(subject_uri: scenario.subject_uri, expected_by_position: scenario.expected_by_position) do
+          authority.search(scenario.query,
+                           subauth: scenario.subauthority_name,
+                           replacements: scenario.replacements)
+        end
+      end
+
+      # Runs the accuracy test and log results
+      def test_accuracy(subject_uri:, expected_by_position:)
+        begin
+          results = yield if block_given?
+          if results.blank?
+            log(status: UNKNOWN, errmsg: "Search position scenario failed; cause: no results found", expected: expected_by_position, target: subject_uri)
+            return
+          end
+
+          check_position(results, subject_uri, expected_by_position)
+        rescue Exception => e
+          log(status: FAIL, errmsg: "Exception executing search position scenario; cause: #{e.message}", expected: expected_by_position, target: subject_uri)
+        end
+      end
+
+      def accuracy_scenario?
+        return false if scenario.expected_by_position.blank? || scenario.subject_uri.blank?
+        true
+      end
+
+      def connection_scenario?
+        # There are only two types of tests, so if this isn't an accuracy scenario, it must be a connection scenario.
+        !accuracy_scenario?
+      end
+
+      def check_position(results, subject_uri, expected_by_position)
+        actual_position = subject_position(results, subject_uri)
+        return if actual_position.blank?
+
+        actual_position += 1
+        if actual_position <= expected_by_position
+          log(status: PASS, expected: expected_by_position, actual: actual_position, target: subject_uri)
+        else
+          log(status: UNKNOWN, errmsg: 'Subject URI not found by the expected position.', expected: expected_by_position, actual: actual_position, target: subject_uri)
+        end
+      end
+
+      def subject_position(results, subject_uri)
+        0.upto(results.size - 1) do |position|
+          return position if results[position][:uri] == subject_uri
+        end
+        log(status: UNKNOWN, errmsg: "Search position scenario failed; cause: subject uri (#{subject_uri}) not found in results", expected: scenario.expected_by_position, target: subject_uri)
+        return nil
+      end
+  end
+end

data/app/validators/qa_server/term_scenario_validator.rb

@@ -0,0 +1,42 @@
+# This class runs a single term scenario and logs the results.
+module QaServer
+  class TermScenarioValidator < ScenarioValidator
+    TERM_ACTION = 'term'.freeze
+
+    # @param scenario [TermScenario] the scenario to run
+    # @param status_log [ScenarioLogger] logger for recording test results
+    # @param validation_type [Symbol] the type of scenarios to run (e.g. VALIDATE_CONNECTION, VALIDATE_ACCURACY, ALL_VALIDATIONS)
+    def initialize(scenario:, status_log:, validation_type: DEFAULT_VALIDATION_TYPE)
+      super
+    end
+
+    # Run a term scenario and log results.
+    def run_connection_scenario
+      test_connection(min_expected_size: scenario.min_result_size, scenario_type_name: 'term') do
+        authority.find(scenario.identifier,
+                       subauth: scenario.subauthority_name)
+      end
+    end
+
+    # Run a term scenario and log results.
+    def run_accuracy_scenario
+      # no accuracy scenarios defined for terms at this time
+    end
+
+    private
+
+      def action
+        TERM_ACTION
+      end
+
+      def accuracy_scenario?
+        # At this time, all scenarios are connection scenarios for terms.
+        false
+      end
+
+      def connection_scenario?
+        # At this time, all scenarios are connection scenarios for terms.
+        true
+      end
+  end
+end

data/app/views/layouts/qa_server.html.erb

@@ -0,0 +1,65 @@
+<!DOCTYPE html>
+<html>
+<head>
+  <title>Authority Lookup Server</title>
+
+  <!-- Latest compiled and minified CSS -->
+  <link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/css/bootstrap.min.css">
+  <!-- jQuery library -->
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!-- Latest compiled JavaScript -->
+  <script src="https://maxcdn.bootstrapcdn.com/bootstrap/3.3.7/js/bootstrap.min.js"></script>
+
+  <%= stylesheet_link_tag    'application', media: 'all', 'data-turbolinks-track': 'reload' %>
+  <%= javascript_include_tag 'application', 'data-turbolinks-track': 'reload' %>
+
+  <%= csrf_meta_tags %>
+
+</head>
+
+<body>
+<section class="ld4l-identity" aria-label="Cornell" role="banner">
+  <div id="skiptocontent"><a href="#maincontent">skip to main content</a></div>
+  <div class="container">
+    <a href="<%= main_app.root_path %>"><img src="<%= image_url('qa_server/LD4L-bg.png') %>" class="header-logo"></a>
+    <a id="logo" class="navbar-brand" href="<%= main_app.root_path %>" data-no-turbolink="true">
+      <span class="institution-name"><%= t("qa_server.application_name") %></span>
+    </a>
+  </div> <!-- /container -->
+</section>
+
+<div class="container">
+  <nav id="masthead" class="navbar navbar-inverse navbar-static-top" role="navigation">
+    <div class="container-fluid">
+      <div class="navbar-header">
+        <ul class="nav-menu">
+          <li class="left-menu"><%= link_to t("qa_server.menu.home"), main_app.root_path %></li>
+          <li class="left-menu"><%= link_to t("qa_server.menu.usage"), qa_server.usage_index_path %></li>
+          <li class="left-menu"><%= link_to t("qa_server.menu.authorities"), qa_server.authority_list_index_path %></li>
+          <li class="left-menu"><%= link_to t("qa_server.menu.check_status"), qa_server.check_status_index_path %></li>
+          <li class="left-menu"><%= link_to t("qa_server.menu.monitor_status"), qa_server.monitor_status_index_path %></li>
+          <li class="right-menu"><%= link_to "LD4L Gateway", "http://ld4l.org/" %></li>
+        </ul>
+      </div>
+    </div>
+  </nav>
+</div>
+</div>
+
+<div id="content-wrapper" class="container" role="main">
+  <a name="skip_to_content"></a>
+  <%# = render '/flash_msg' %>
+  <% if content_for?(:page_header) %>
+      <div class="row">
+        <div class="col-xs-12 main-header">
+          <%= yield(:page_header) %>
+        </div>
+      </div>
+  <% end %>
+
+  <%= content_for?(:content) ? yield(:content) : yield %>
+</div><!-- /#content-wrapper -->
+<%= render 'shared/footer' %>
+<%# = render 'shared/ajax_modal' %>
+</body>
+</html>

data/app/views/qa_server/authority_list/index.html.erb

@@ -0,0 +1,27 @@
+<div class="page-description">
+
+  <h2><%= t('qa_server.authority_list.title') %></h2>
+  <p><%= t('qa_server.authority_list.see_check_status_html', href: "#{main_app.root_path}check_status") %></p>
+
+  <div id="status-section" class="status-section">
+    <p><b><%= t('qa_server.warning.chrome_unencoding_msg') %></b></p>
+    <table class="status">
+      <tr>
+        <th><%= t('qa_server.authority_list.data.authority') %></th>
+        <th><%= t('qa_server.authority_list.data.subauthority') %></th>
+        <th><%= t('qa_server.authority_list.data.service') %></th>
+        <th><%= t('qa_server.authority_list.data.action') %></th>
+        <th><%= t('qa_server.authority_list.data.url') %></th>
+      </tr>
+      <% @presenter.urls_data.each do |entry| %>
+          <tr>
+            <td><%= entry[:authority_name] %></td>
+            <td><%= entry[:subauthority_name] %></td>
+            <td><%= entry[:service] %></td>
+            <td><%= entry[:action] %></td>
+            <td><a href="<%= entry[:url] %>"><%= entry[:url] %></a></td>
+          </tr>
+      <% end %>
+    </table>
+  </div>
+</div>

data/app/views/qa_server/check_status/index.html.erb

@@ -0,0 +1,104 @@
+<script>
+  function validate_authority(form) {
+    form.submit();
+    document.getElementById('status-loading-message').style.display = 'block';
+    document.getElementById('connection-status-section').style.display = 'none';
+    document.getElementById('accuracy-status-section').style.display = 'none';
+    document.getElementById('example-url-warning').style.display = 'none';
+  }
+</script>
+
+<div class="page-description">
+
+  <h2><%= t('qa_server.check_status.title') %></h2>
+
+  <%= form_tag({ action: 'index' }, { method: :get }) do %>
+  <select name="authority" id="authority" class="string multi-value optional form-control form-control multi-text-field" value="" aria-labelledby="authority" onchange="validate_authority(this.form)">
+    <option value=""><%= t('qa_server.check_status.select_authority') %></option>
+    <option disabled>──────────</option>
+    <option value="<%= @presenter.value_all_collections %>"><%= t('qa_server.check_status.show_all') %></option>
+    <option disabled>──────────</option>
+    <% @authorities_list.each do |auth_name| %>
+        <option value="<%= auth_name %>"><%= auth_name.upcase %></option>
+    <% end %>
+  </select>
+  <div class="validation-types">
+    <%= radio_button_tag(@presenter.value_check_param, @presenter.value_check_connections, :selected) %>
+    <%= label_tag(@presenter.label_check_connections, t('qa_server.check_status.connections'), class: 'horizontal-list') %>
+    <%= radio_button_tag(@presenter.value_check_param, @presenter.value_check_accuracy) %>
+    <%= label_tag(@presenter.label_check_accuracy, t('qa_server.check_status.accuracy'), class: 'horizontal-list') %>
+    <%= radio_button_tag(@presenter.value_check_param, @presenter.value_all_checks) %>
+    <%= label_tag(@presenter.label_all_checks, t('qa_server.check_status.all_checks'), class: 'horizontal-list') %>
+  </div>
+  <% end %>
+
+
+<div id="status-loading-message" class="wait-message"><%= t('qa_server.check_status.wait_message') %></div>
+
+<% if @presenter.connection_status_data? || @presenter.accuracy_status_data? %>
+  <div id="example-url-warning">
+      <p><b><%= t('qa_server.warning.chrome_unencoding_msg') %></b></p>
+  </div>
+<% end %>
+
+<% if @presenter.connection_status_data? %>
+<div id="connection-status-section" class="status-section">
+  <h3><%= t('qa_server.check_status.connection_checks') %></h3>
+  <table class="status">
+    <tr>
+      <th><%= t('qa_server.check_status.status_table.status') %></th>
+      <th><%= t('qa_server.check_status.status_table.authority') %></th>
+      <th><%= t('qa_server.check_status.status_table.subauthority') %></th>
+      <th><%= t('qa_server.check_status.status_table.service') %></th>
+      <th><%= t('qa_server.check_status.status_table.action') %></th>
+      <th><%= t('qa_server.check_status.status_table.url') %></th>
+      <th><%= t('qa_server.check_status.status_table.errmsg') %></th>
+    </tr>
+    <% @presenter.connection_status_data.each do |status| %>
+    <tr>
+      <td class="<%= @presenter.status_style_class(status) %>"><%= status[:status_label] %></td>
+      <td><%= status[:authority_name] %></td>
+      <td><%= status[:subauthority_name] %></td>
+      <td><%= status[:service] %></td>
+      <td><%= status[:action] %></td>
+      <td><a href="<%= status[:url] %>"><%= status[:url] %></a></td>
+      <td><%= status[:err_message] %></td>
+    </tr>
+    <% end %>
+  </table>
+</div>
+<% end %>
+
+<% if @presenter.accuracy_status_data? %>
+<div id="accuracy-status-section" class="status-section">
+  <h3><%= t('qa_server.check_status.accuracy_checks') %></h3>
+  <table class="status">
+    <tr>
+      <th><%= t('qa_server.check_status.status_table.expected_by_position') %></th>
+      <th><%= t('qa_server.check_status.status_table.actual_position') %></th>
+      <th><%= t('qa_server.check_status.status_table.subject_uri') %></th>
+      <th><%= t('qa_server.check_status.status_table.authority') %></th>
+      <th><%= t('qa_server.check_status.status_table.subauthority') %></th>
+      <th><%= t('qa_server.check_status.status_table.service') %></th>
+      <th><%= t('qa_server.check_status.status_table.action') %></th>
+      <th><%= t('qa_server.check_status.status_table.url') %></th>
+      <th><%= t('qa_server.check_status.status_table.errmsg') %></th>
+    </tr>
+    <% @presenter.accuracy_status_data.each do |status| %>
+    <tr>
+      <td class="position <%= @presenter.status_style_class(status) %>"><%= status[:expected] %></td>
+      <td class="position <%= @presenter.status_style_class(status) %>"><%= status[:actual] %></td>
+      <td><a href="<%= status[:target] %>"><%= status[:target] %></a></td>
+      <td><%= status[:authority_name] %></td>
+      <td><%= status[:subauthority_name] %></td>
+      <td><%= status[:service] %></td>
+      <td><%= status[:action] %></td>
+      <td><a href="<%= status[:url] %>"><%= status[:url] %></a></td>
+      <td><%= status[:err_message] %></td>
+    </tr>
+    <% end %>
+  </table>
+</div>
+<% end %>
+
+</div>

data/app/views/qa_server/homepage/index.html.erb

@@ -0,0 +1,10 @@
+<div class="page-description">
+  <p class="welcome">This service provides authority <b>lookup for single terms</b> and <b>search for terms</b> matching a query.
+    See <a href="<%= "#{main_app.root_path}usage" %>">Usage</a> for more information.</p>
+  <p class="welcome2">It has been created as part of the
+    <a href="http://ld4l.org" target="_blank">LD4L Labs project</a>, and is operated by
+    <a href="http://www.library.cornell.edu/" target="_blank">Cornell University Library</a>
+    in collaboration with the
+    <a href="https://www.slis.uiowa.edu/" target="_blank">School of Library and Information Science, University of Iowa</a>.
+    This work was funded through a grant from the <a href="https://mellon.org/" target="_blank">Andrew W. Mellon Foundation</a>.</p>
+</div>

data/app/views/qa_server/monitor_status/index.html.erb

@@ -0,0 +1,78 @@
+<div class="page-description">
+  <h2><%= t('qa_server.monitor_status.summary.title') %></h2>
+
+  <table class="monitor-status-status">
+    <tr>
+      <th><%= t('qa_server.monitor_status.summary.authorities') %></th>
+      <th><%= t('qa_server.monitor_status.summary.authorities_with_failures') %></th>
+      <th><%= t('qa_server.monitor_status.summary.passing_tests') %></th>
+      <th><%= t('qa_server.monitor_status.summary.failing_tests') %></th>
+      <th><%= t('qa_server.monitor_status.summary.total_tests') %></th>
+    </tr>
+    <tr>
+      <td><%= @presenter.authorities_count %></td>
+      <td class="<%= @presenter.authorities_count_style %>"><%= @presenter.failing_authorities_count %></td>
+      <td><%= @presenter.passing_tests_count%></td>
+      <td class="<%= @presenter.failing_tests_style %>"><%= @presenter.failing_tests_count %></td>
+      <td><%= @presenter.tests_count %></td>
+    </tr>
+  </table>
+  <p class="status-update-dtstamp"><%= t('qa_server.monitor_status.summary.last_updated', date: @presenter.last_updated) %></p>
+
+  <% if @presenter.failures? %>
+    <div id="status-section" class="status-section">
+      <h2><%= t('qa_server.monitor_status.failures.title') %></h2>
+
+      <p><b><%= t('qa_server.warning.chrome_unencoding_msg') %></b></p>
+      <table class="status">
+        <tr>
+          <th><%= t('qa_server.monitor_status.failures.status') %></th>
+          <th><%= t('qa_server.monitor_status.failures.authority') %></th>
+          <th><%= t('qa_server.monitor_status.failures.subauthority') %></th>
+          <th><%= t('qa_server.monitor_status.failures.service') %></th>
+          <th><%= t('qa_server.monitor_status.failures.action') %></th>
+          <th><%= t('qa_server.monitor_status.failures.url') %></th>
+          <th><%= t('qa_server.monitor_status.failures.errmsg') %></th>
+        </tr>
+        <% @status_data.each do |status| %>
+            <tr>
+              <td class="<%= "status-#{status[:status].to_s}" %>"><%= status[:status_label] %></td>
+              <td><%= status[:authority_name] %></td>
+              <td><%= status[:subauthority_name] %></td>
+              <td><%= status[:service] %></td>
+              <td><%= status[:action] %></td>
+              <td><a href="<%= status[:url] %>"><%= status[:url] %></a></td>
+              <td><%= status[:err_message] %></td>
+            </tr>
+        <% end %>
+      </table>
+    </div>
+  <% end %>
+
+  <% if @presenter.history? %>
+      <div id="status-section" class="status-section">
+        <h2><%= t('qa_server.monitor_status.history.title') %></h2>
+
+        <h3><%= t('qa_server.monitor_status.history.since', date: @presenter.first_updated) %></h3>
+
+        <table class="status">
+          <tr>
+            <th><%= t('qa_server.monitor_status.history.days_failing') %></th>
+            <th><%= t('qa_server.monitor_status.history.authority') %></th>
+            <th><%= t('qa_server.monitor_status.history.subauthority') %></th>
+            <th><%= t('qa_server.monitor_status.history.service') %></th>
+            <th><%= t('qa_server.monitor_status.history.action') %></th>
+          </tr>
+          <% @presenter.history.each do |entry| %>
+              <tr>
+                <td><%= entry[:days_failing] %></td>
+                <td><%= entry[:authority_name] %></td>
+                <td><%= entry[:subauthority_name] %></td>
+                <td><%= entry[:service] %></td>
+                <td><%= entry[:action] %></td>
+              </tr>
+          <% end %>
+        </table>
+      </div>
+  <% end %>
+</div>

data/app/views/qa_server/usage/index.html.erb

@@ -0,0 +1,106 @@
+<div class="page-description">
+
+  <h2>Usage:</h2>
+  <h3>To search for matching terms:</h3>
+
+  <p>The query parameter <b>q</b> is required.  All other parameters are optional.  Some authorities support different
+  optional parameters, but attempts were made to keep optional parameter names consistent between authorities.</p>
+
+  <h4>Without subauthority:</h4>
+  <pre>/<%= QaServer::QA_ENGINE_MOUNT %>/search/linked_data/locnames_ld4l_cache?q=mark%20twain&maxRecords=4&lang=en</pre>
+
+  where,
+  <ul>
+    <li>search (required) - indicates this is a query for terms</li>
+    <li>locnames_ld4l_cache (required) - the name of the authority</li>
+    <li>q=mark twain (required) - the query for which to search</li>
+    <li>maxRecords=4 (optional) - the number of results to return</li>
+    <li>lang=en (optional) - if the authority returns language encoded literals, results will be filtered for English
+  </ul>
+
+  <h4>With subauthority</h4>
+  <pre>/<%= QaServer::QA_ENGINE_MOUNT %>/search/linked_data/locnames_ld4l_cache/person?q=mark%20twain&maxRecords=4&lang=en</pre>
+
+  where,
+  <ul>
+    <li>search (required) - indicates this is a query for terms</li>
+    <li>locnames_ld4l_cache (required) - the name of the authority</li>
+    <li>person (optional) - limits results to this subauthority (meaning of subauthoritites is authority dependent)</li>
+    <li>q=mark twain (required) - the query for which to search</li>
+    <li>maxRecords=4 (optional) - the number of results to return</li>
+    <li>lang=en (optional) - if the authority returns language encoded literals, results will be filtered for the specified language
+  </ul>
+
+  <h4>Results format:</h4>
+  <p>The results minimally contain the uri, id, and label for each result found.  The uri and id may be the same, but not
+  in all cases.</p>
+
+  <p>Example of results with two terms found:</p>
+  <pre>
+[
+  {
+    "uri":"http://id.loc.gov/authorities/names/n92016188",
+    "id":"http://id.loc.gov/authorities/names/n92016188",
+    "label":"Twain, Mark, 1835-1910. Mark Twain papers"
+  },
+  {
+    "uri":"http://id.loc.gov/authorities/names/n42025440",
+    "id":"http://id.loc.gov/authorities/names/n42025440",
+    "label":"Twain, Mark, 1835-1910. Mark Twain library"
+  }
+]</pre>
+
+<hr>
+  <h3>To fetch a single term:</h3>
+
+  <p>The data after the authority name is required and should be the URI or the ID of the term being retrieved.
+  Which value to use depends on the authority configuration.  All other parameters are optional.  Some
+  authorities support different optional parameters, but attempts were made to keep optional parameter names
+  consistent between authorities.</p>
+
+  <h4>Fetch by URI</h4>
+  <pre>/<%= QaServer::QA_ENGINE_MOUNT %>/show/linked_data/locnames_ld4l_cache/http%3A%2F%2Fid%2Eloc%2Egov%2Fauthorities%2Fnames%2Fn92016188</pre>
+  <p><b><%= t('qa_server.warning.chrome_unencoding_msg') %></b></p>
+
+  where,
+  <ul>
+    <li>show (required) - indicates this is a fetch of a single term</li>
+    <li>locnames_ld4l_cache (required) - the name of the authority</li>
+    <li>http%3A%2F%2Fid%2Eloc%2Egov%2Fauthorities%2Fnames%2Fn92016188 (required) - the encoded uri of the term to fetch</li>
+    <li>lang=en (optional) - if the authority returns language encoded literals, results will be filtered for the specified language</li>
+  </ul>
+
+  <h4>Fetch by ID</h4>
+  <pre>/<%= QaServer::QA_ENGINE_MOUNT %>/show/linked_data/oclcfast_ld4l_cache/1914919?lang=en</pre>
+
+  where,
+  <ul>
+    <li>show (required) - indicates this is a fetch of a single term</li>
+    <li>oclcfast_ld4l_cache (required) - the name of the authority</li>
+    <li>1914919 (required) - the id of the term to fetch</li>
+    <li>lang=en (optional) - if the authority returns language encoded literals, results will be filtered for the specified language
+  </ul>
+
+  <h4>Results format:</h4>
+  <p>The results minimally contain the uri, id, and label of the term.  The uri and id may be the same, but not
+  in all cases.  All predicate and object values where the term is the subject are also returned in the predicates list.</p>
+
+  <p>Example results for a fetch of a term:</p>
+  <pre>
+{
+  "uri":"http://id.worldcat.org/fast/530369",
+  "id":"530369",
+  "label":"Cornell University",
+  "altlabel":["Ithaca (N.Y.). Cornell University"],
+  "sameas":["http://id.loc.gov/authorities/names/n79021621","https://viaf.org/viaf/126293486"],
+  "predicates":{
+    "http://purl.org/dc/terms/identifier":"530369",
+    "http://www.w3.org/2004/02/skos/core#inScheme":["http://id.worldcat.org/fast/ontology/1.0/#fast","http://id.worldcat.org/fast/ontology/1.0/#facet-Corporate"],
+    "http://www.w3.org/1999/02/22-rdf-syntax-ns#type":"http://schema.org/Organization",
+    "http://www.w3.org/2004/02/skos/core#prefLabel":"Cornell University",
+    "http://schema.org/name":["Cornell University","Ithaca (N.Y.). Cornell University"],
+    "http://www.w3.org/2004/02/skos/core#altLabel":["Ithaca (N.Y.). Cornell University"],
+    "http://schema.org/sameAs":["http://id.loc.gov/authorities/names/n79021621","https://viaf.org/viaf/126293486"]
+  }
+}</pre>
+</div>