Merge pull request #10 from opencitations/fixing-html-meta-description-ramose

rempairamore · web-flow · commit 2fdcdda6f38d · 2025-10-30T15:14:11.000+01:00
Fixing html tag (description)
diff --git a/docker_version.txt b/docker_version.txt
@@ -1 +1 @@
-1.4.4sync
+1.5.2sync
diff --git a/html-template/api.html b/html-template/api.html
@@ -5,6 +5,7 @@
 <head>
   <meta charset="UTF-8" />
   <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+  <meta name="description" content="Access open citation data and bibliographic metadata via REST API. Query Index and Meta endpoints using DOI, ORCID, PMID, OMID, ISBN, ISSN. Free access." />
   <title>OpenCitations - API</title>
   <!-- Bootstrap CSS -->
   <link href="/static/bootstrap-533/css/bootstrap.min.css" rel="stylesheet" />
diff --git a/src/api/index_v1.hf b/src/api/index_v1.hf
@@ -2,6 +2,7 @@
 #type api
 #base https://api.opencitations.net/index
 #title The unifying REST API for all the OpenCitations Indexes
+#html_meta_description Old Version of OpenCitations INDEX API
 #description This document describe the REST API for accessing the data stored in all the [OpenCitations Indexes](https://w3id.org/oc/index) hosted by [OpenCitations](http://opencitations.net). This API implements operations to retrieve the citation data for all the references to other works appearing in a particular bibliographic entity, or the citation data for all the references appearing in other works to a particular bibliographic entity, given the DOI of a bibliographic entity, or to retrieve citation data about a particular citation identified by means of its [Open Citation Identifier (OCI)](https://opencitations.wordpress.com/2018/03/12/citations-as-first-class-data-entities-open-citation-identifiers/).
 
 All the present operations return either a JSON document (default) or a CSV document according to the mimetype specified in the `Accept` header of the request. If you would like to suggest an additional operation to be included in this API, please use the [issue tracker](https://github.com/opencitations/api/issues) of the OpenCitations APIs available on GitHub.
diff --git a/src/api/index_v2.hf b/src/api/index_v2.hf
@@ -2,6 +2,7 @@
 #type api
 #base https://api.opencitations.net/index
 #title The REST API for OpenCitations Index
+#html_meta_description OpenCitations Index REST API: retrieve citation data, bibliographic references, citation counts using DOI, PMID, OMID identifiers. Free access.
 #description This document describe the REST API for accessing the data stored in the [OpenCitations Index](https://w3id.org/oc/index) hosted by [OpenCitations](http://opencitations.net). This API implements operations to retrieve the citation data for all the references to other works appearing in a particular bibliographic entity, or the citation data for all the references appearing in other works to a particular bibliographic entity, given the identifier of a bibliographic entity, or to retrieve citation data about a particular citation identified by means of its [Open Citation Identifier (OCI)](https://opencitations.wordpress.com/2018/03/12/citations-as-first-class-data-entities-open-citation-identifiers/).
 
 All the present operations return either a JSON document (default) or a CSV document according to the mimetype specified in the `Accept` header of the request. If you would like to suggest an additional operation to be included in this API, please use the [issue tracker](https://github.com/opencitations/api/issues) of the OpenCitations APIs available on GitHub.
diff --git a/src/api/meta_v1.hf b/src/api/meta_v1.hf
@@ -2,6 +2,7 @@
 #type api
 #base https://api.opencitations.net/meta
 #title The REST API for OpenCitations Meta
+#html_meta_description OpenCitations Meta REST API: retrieve bibliographic metadata, authors, editors, venues using DOI, ORCID, PMID, OMID, ISBN, ISSN identifiers. Free access.
 #description This is the REST API for OpenCitations Meta, the OpenCitations dataset containing bibliographic metadata associated with the documents involved in the citations stored in the OpenCitations Indexes. All the present operations return either a JSON document (default) or a CSV document according to the mimetype specified in the `Accept` header of the request. If you would like to suggest an additional operation to be included in this API, please use the [issue tracker](https://github.com/opencitations/api/issues) of the OpenCitations APIs available on GitHub.
 
 If you are going to use the REST APIs within an application/code, we encourage you to get the [OpenCitations Access Token](https://opencitations.net/accesstoken) and specify it in the "authorization" header of your REST API call. Here is a usage example in Python:
diff --git a/src/ramose.py b/src/ramose.py
@@ -143,6 +143,10 @@ def __title(self, conf):
         """This method returns the title string defined in the API specification."""
         return conf["conf_json"][0]["title"]
 
+    def __htmlmetadescription(self, conf):
+        """This method returns the HTML meta-description string defined in the API specification."""
+        return conf["conf_json"][0]["html_meta_description"]
+
     def __sidebar(self, conf):
         """This method builds the sidebar of the API documentation"""
         result = ""
@@ -724,7 +728,7 @@ def get_documentation(self, css_path=None, base_url=None):
         """This method generates the HTML documentation of an API described in configuration file."""
         if base_url is None:
             first_key = next(iter(self.conf_doc))
-            conf = self.conf_doc[first_key]
+            conf = self.conf_doc[first_key] 
         else:
             conf = self.conf_doc['/'+base_url]
 
@@ -734,6 +738,7 @@ def get_documentation(self, css_path=None, base_url=None):
         <title>%s</title>
         <meta http-equiv="content-type" content="text/html; charset=utf-8"/>
         <meta name="viewport" content="width=device-width" />
+        <meta name="description" content="%s"/>
         <style>%s</style>
         %s
     </head>
@@ -743,7 +748,16 @@ def get_documentation(self, css_path=None, base_url=None):
         <section id="operations">%s</section>
         <footer>%s</footer>
     </body>
-</html>""" % (self.__title(conf), self.__css(), self.__css_path(css_path), self.__sidebar(conf), self.__header(conf), self.__operations(conf), self.__footer())
+</html>""" % (
+            self.__title(conf),
+            self.__htmlmetadescription(conf),
+            self.__css(),
+            self.__css_path(css_path),
+            self.__sidebar(conf),
+            self.__header(conf),
+            self.__operations(conf),
+            self.__footer()
+        )
 
     def get_index(self, css_path=None):
         """This method generates the index of all the HTML documentations that can be
