| ... | ... | @@ -49,18 +49,10 @@ The Energy Toolbox API includes both the Consumption Analysis API and the Energy |
|
|
|
|
|
|
|
http://<local_ip>:3002/analysis?new=T&user=<github-user>&token=<github-token>&url=<github-url>&commit=<github_commit>&type=<analysis-type>
|
|
|
|
|
|
|
|
| Parameter | Description | Required | Notes |
|
|
|
|
|:------------:|:---------------------------------------------------------------:|:--------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
|
|
|
|
|
|
|
| url | The URL of the repository to be analyzed | String | - |
|
|
|
|
| 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.
|
|
|
|
|
|
|
|
| Parameter | Description | Type | Notes |
|
|
|
|
|:------------:|:---------------------------------------------------------------:|:--------:|:-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
|
|
|
|
| url | The URL of the repository to be analyzed | String | - |
|
|
|
|
| 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 |
