Tools API
=========

============
Tool Methods
============

.. http:get:: /tools

    Lists available tools

    :reqheader Authorization: API key or Bearer token for user authentication

    **Response Syntax**:

    .. sourcecode:: json

     [
       {
         "tool_id": "string",
         "tool_name": "string",
         "tool_description": "string"
       }
     ]


    :raises: May raise exceptions related to database operations or service availability.


.. http:post:: /tools

    :reqheader Authorization: API key or Bearer token for user authentication

    **Request Syntax**:

    .. sourcecode:: json

     {
       "tool_name": "string",
       "tool_description": "string"
     }

    
    **Response Syntax**:

    A Tool object.

    .. sourcecode:: json

     {
       "tool_id": "string",
       "tool_name": "string",
       "tool_description": "string"
     }


.. http:post:: /tools/<tool_id>

    Submits a job or batch of jobs to the tool execution service

    :reqheader Authorization: API key or Bearer token for user authentication
    :status 200: Success. Returns the job id(s).
    :status 500: Unknown error occurred during processing.

    **Request Syntax**:

    .. sourcecode:: json

       {
          "fixed_args": [
            {
              "argument_key": "string",
              "argument_value": "string"
            }
          ],
          "variable_args": [
            [
              {
                "argument_key": "string",
                "argument_value": "string"
              }
            ]
          ],
          "hardware": {
            "filesystem_list": [
              {
                "filesystem_id": "string",
                "filesystem_name": "string"
              }
            ],
            "memory": 123,
            "cpu": 123
          }
       }

    **Response Syntax**:

    A Batch object.

    .. sourcecode:: json

     {
       "batch_id": "string",
       "batch_tool": {
         "tool_id": "string",
         "tool_name": "string",
         "tool_description": "string"
       },
       "n_jobs": 123,
       "batch_hardware": {
         "filesystem_list": [
           {
             "filesystem_id": "string",
             "filesystem_name": "string"
           }
         ],
         "cpu": 123
         "memory": 123,
       } 
     }

    :raises: May raise exceptions related to database operations or service availability.

.. http:delete:: /tools/<tool_id>

    Deletes the specified tool.



.. http:post:: /tools/<tool_id>/share

    Shares the tool with the specified user.