... | ... | @@ -56,4 +56,10 @@ http://<local_ip>:3002/analysis?new=T&user=<github-user>&token=<github-token>&ur |
|
|
| user | The user name of the repository owner | string | - |
|
|
|
| token | Private access token in the case of private repo | string | Example: GitHub private access token |
|
|
|
| type | whether to run a full, hotspots-only, static-only, acceleration or history analysis. Supported values: ['full', 'hotspots', 'static', 'acceleration', 'history'] | string | This parameter implements the selection between the toolbox components as well as their individual functionalities |
|
|
|
| new | whether to run a new analysis, or return existing results (if any)| bool | From our tests, a bool parameter is considered True if and only if it is non-emtpy. |
|
|
\ No newline at end of file |
|
|
| new | whether to run a new analysis, or return existing results (if any)| bool | From our tests, a bool parameter is considered True if and only if it is non-emtpy.
|
|
|
|
|
|
| Parameter | Description | Required | Valid Inputs |
|
|
|
|:------------:|:---------------------------------------------------------------:|:--------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
|
|
| project | The URL of the software project that should be analyzed. | Yes | Any valid URL that points to an existing online Git repository (e.g., GitHub, GitLab, Bitbucket, etc.). |
|
|
|
| language | The programming language of the software project that needs to be analyzed. | Yes | One of the following string values: : <br/>·“java” if the selected software project is written in Java programming language. <br/> ·“cpp” if the selected software project is written in C/C++ programming language. <br/> Default value is "java". |
|
|
|
| inspection | If the model will return the detailed results of the analysis or not. | No | One of the following string values: [‘yes’, ‘no’].<br>Default value is ‘no'. | |
|
|
\ No newline at end of file |