add links to schemas in parameters reference

Author: softwareengineerprogrammer

src/geophires_x_schema_generator/__init__.py

@@ -253,17 +253,38 @@ def get_input_params_table(_category_params, category_name) -> str:
 
         output_rst = self.get_output_params_table_rst(output_params_json)
 
+        schema_ref_base_url = (
+            'https://github.com/softwareengineerprogrammer/GEOPHIRES/blob/main/src/geophires_x_schema_generator/'
+        )
+        input_schema_ref_rst = ''
+        if self.get_input_schema_reference() is not None:
+            input_schema_ref_rst = (
+                f'Schema: '
+                f'`{self.get_input_schema_reference()} '
+                f'<{schema_ref_base_url}{self.get_input_schema_reference()}>`__'
+            )
+
+        output_schema_ref_rst = ''
+        if self.get_output_schema_reference() is not None:
+            output_schema_ref_rst = (
+                f'Schema: '
+                f'`{self.get_output_schema_reference()} '
+                f'<{schema_ref_base_url}{self.get_output_schema_reference()}>`__'
+            )
+
         rst = f"""{self.get_schema_title()} Parameters
 ==========
 
 .. contents::
 
 Input Parameters
 ################
+{input_schema_ref_rst}
 {input_rst}
 
-Output Parameters
+Outputs
 #################
+{output_schema_ref_rst}
 {output_rst}
 """
 
@@ -287,7 +308,7 @@ def get_output_params_table(_category_params, category_name) -> str:
             _output_rst = f"""
 {category_display}
 {'-' * len(category_display)}
-    .. list-table:: {category_display}{' ' if len(category_display) > 0 else ''}Parameters
+    .. list-table:: {category_display}{' ' if len(category_display) > 0 else ''}Outputs
        :header-rows: 1
 
        * - Name
@@ -309,6 +330,12 @@ def get_output_params_table(_category_params, category_name) -> str:
 
         return output_rst
 
+    def get_input_schema_reference(self) -> str:
+        return 'geophires-request.json'
+
+    def get_output_schema_reference(self) -> str:
+        return 'geophires-result.json'
+
 
 def _get_key(param: dict, k: str, default_val='') -> Any:
     if k in param and str(param[k]) != '':
@@ -358,7 +385,7 @@ def get_output_params_table_rst(self, output_params_json) -> str:
         output_params = json.loads(output_params_json)
 
         output_rst = """
-    .. list-table:: Output Parameters
+    .. list-table:: Outputs
        :header-rows: 1
 
        * - Name
@@ -382,6 +409,12 @@ def get_key(k):
 
         return output_rst
 
+    def get_input_schema_reference(self) -> str:
+        return 'hip-ra-x-request.json'
+
+    def get_output_schema_reference(self) -> str:
+        return None
+
 
 def _get_logger(logger_name=None):
     sh = logging.StreamHandler(sys.stdout)