Add link to API usage policy

hbz · Sep 19, 2023 · 6c50d7a · 6c50d7a
1 parent 0daf7f3
commit 6c50d7a
Show file tree

Hide file tree

Showing 4 changed files with 15 additions and 0 deletions.
diff --git a/app/views/api.scala.html b/app/views/api.scala.html
@@ -31,6 +31,10 @@
 }
 
 @main("*", scripts = hypothesisEmbed) {
+    <div id="usage-policy" class="alert alert-info" role="alert">
+        <span class="glyphicon glyphicon-info-sign" aria-hidden="true"></span>
+        @Html(@Messages.get("api.usage.policy", "https://lobid.org/usage-policy/"))
+    </div>
     <h2 id="basics">@Messages.get("api.basics.header") <small><a href="#basics"><span class="glyphicon glyphicon-link"></span></a></small></h2>
     <dl>
     @desc("HTTP GET", routes.Application.get("DE-6", format="json"))

diff --git a/conf/messages.de b/conf/messages.de
@@ -47,6 +47,7 @@ search.position_sort = In Ihrer Nähe
 
 # api
 
+api.usage.policy = Technische und sonstige Hinweise zur lobid-Nutzung finden sich in den <a class="alert-link href="{0}">Richtlinien zur API-Nutzung</>.
 api.basics.header = API-Grundlagen
 api.basics.search = Suche über alle Felder
 api.basics.pagination = Suche mit Paginierung

diff --git a/conf/messages.en b/conf/messages.en
@@ -47,6 +47,7 @@ search.position_sort = Close to you
 
 # api
 
+api.usage.policy = Technical and other guidance on the usage of lobid can be found in the <a class="alert-link href="{0}">API Usage Guidelines</a>.
 api.basics.header = API basics
 api.basics.search = Query all fields
 api.basics.pagination = Query with pagination

diff --git a/public/stylesheets/main.css b/public/stylesheets/main.css
@@ -122,3 +122,12 @@ small {
 	color: blue;
 	z-index: 100 !important;
 }
+
+#usage-policy {
+	margin-top: 20px;
+	/*
+	setting standard background-color for .alert-info
+	https://getbootstrap.com/docs/3.3/components/#alerts
+	*/
+	background-color: #d9edf7;
+}