Merge pull request #63 from UN-OCHA/develop

Add beta info
UN-OCHA · Dec 13, 2023 · 7adf7b2 · 7adf7b2
2 parents 9ec8eb9 + 179694a
commit 7adf7b2
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 1 deletion.
diff --git a/config/packages/api_platform.yaml b/config/packages/api_platform.yaml
@@ -1,6 +1,6 @@
 api_platform:
     title: 'OCHA API'
-    description: 'The public OCHA API'
+    description: 'This is a beta API that OCHA is testing to pull together key figures to power some of its own websites (e.g. unocha.org). It will not contain detailed data from each of the sources. If you are interested detailed data, we suggest you use the respective sources API. Questions: email [email protected]'
     version: 1.0.1
     show_webby: false
     name_converter: 'Symfony\Component\Serializer\NameConverter\CamelCaseToSnakeCaseNameConverter'

diff --git a/templates/home.html.twig b/templates/home.html.twig
@@ -5,6 +5,12 @@
 {% block body %}
 <h1 class="cd-page-title">OCHA Key Figures API</h1>
 
+<h2>About</h2>
+
+<p>This is a beta API that OCHA is testing to pull together key figures to power some of its own websites (e.g. unocha.org).
+It will not contain detailed data from each of the sources. If you are interested detailed data, we suggest you use the respective sources' API.</p>
+<p>Questions: see the <a href="#feedback">Feedback and support</a> section on this page.</p>
+
 <h2>Embed OCHA content in your websites</h2>
 <p>OCHA has started to offer some of its own key figures and ReliefWeb's Crisis Figures through a single API. Consume and transform the content to display on your own website. Here is a summary of what we currently offer:</p>