Add API Spec v2.1.0

Author: abhaasgoyal

.github/workflows/ci.yml

@@ -34,6 +34,9 @@ jobs:
         MEORG_EMAIL: ${{ secrets.MEORG_EMAIL }}
         MEORG_PASSWORD: ${{ secrets.MEORG_PASSWORD }}
         MEORG_MODEL_OUTPUT_ID: ${{ secrets.MEORG_MODEL_OUTPUT_ID }}
+        MEORG_MODEL_OUTPUT_NAME: ${{ secrets.MEORG_MODEL_OUTPUT_NAME}}
+        MEORG_MODEL_PROFILE_ID: ${{ secrets.MEORG_MODEL_PROFILE_ID }}
+        MEORG_EXPERIMENT_ID: ${{ secrets.MEORG_EXPERIMENT_ID }}
       run: |
         conda install pytest
         pytest -v

meorg_client/cli.py

@@ -214,6 +214,42 @@ def analysis_start(id: str):
         click.echo(analysis_id)
 
 
+@click.command("create")
+@click.argument("model_id")
+@click.argument("exp_id")
+@click.argument("name")
+def create_new_model_output(model_id: str, exp_id: str, name: str):
+    """
+    Create a new model output entity
+
+
+    Parameters
+    ----------
+    model_id : str
+        Model profile ID.
+
+    exp_id : str
+        Experiment ID.
+
+    name : str
+        New model output name
+
+    Prints modeloutput ID of created object, and whether it already existed or not.
+    """
+    client = _get_client()
+
+    response = _call(
+        client.post_output_entity, model_id=model_id, exp_id=exp_id, name=name
+    )
+
+    if client.success():
+        output_id = response.get("data").get("modeloutputId")
+        created = response.get("data").get("created")
+        click.echo(f"Model Output ID: {output_id}")
+        click.echo(f"Override (existing) Model Output ID: {created}")
+    pass
+
+
 @click.command("status")
 @click.argument("id")
 def analysis_status(id: str):
@@ -291,6 +327,11 @@ def cli_analysis():
     pass
 
 
+@click.group("output", help="Model output commands.")
+def cli_output():
+    pass
+
+
 # Add file commands
 cli_file.add_command(file_list)
 cli_file.add_command(file_upload)
@@ -304,6 +345,9 @@ def cli_analysis():
 cli_analysis.add_command(analysis_start)
 cli_analysis.add_command(analysis_status)
 
+# Add output command
+cli_output.add_command(create_new_model_output)
+
 # Add subparsers to the master
 cli.add_command(cli_endpoints)
 cli.add_command(cli_file)

meorg_client/client.py

@@ -442,6 +442,31 @@ def start_analysis(self, id: str) -> Union[dict, requests.Response]:
             url_params=dict(id=id),
         )
 
+    def post_output_entity(
+        self, model_id: str, exp_id: str, name: str
+    ) -> Union[dict, requests.Response]:
+        """
+        Create a new model output entity
+        Parameters
+        ----------
+        model_id : str
+            Model Profile ID
+        exp_id : str
+            Experiment ID
+        name : _type_
+            Name of Model Output
+
+        Returns
+        -------
+        Union[dict, requests.Response]
+            Response from ME.org.
+        """
+        return self._make_request(
+            method=mcc.HTTP_POST,
+            endpoint=endpoints.MODEL_OUTPUT,
+            data=dict(experiment=exp_id, model=model_id, name=name),
+        )
+
     def get_analysis_status(self, id: str) -> Union[dict, requests.Response]:
         """Check the status of the analysis chain.