mirrors/compiler-explorer
1
0
Fork 0
mirror of https://github.com/compiler-explorer/compiler-explorer.git synced 2025-12-27 09:23:52 -05:00
Code Issues Packages Projects Releases Wiki Activity

extend documentation

Browse Source
This commit is contained in:
Partouf
2019-07-12 15:10:08 +02:00
parent 125f4d360f
commit e70aa4f3b3
1 changed files with 8 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/API.md
View File

@@ -36,7 +36,9 @@ Returns a list of compilers for the provided language id. In text form,
Returns a list of libraries and library versions available for the provided language id.
This request only returns data in JSON.
You can use the given include paths to supply in the userArguments for compilation.
You can use the given include paths to supply in the userArguments for compilation. *(deprecated)*
You will need the library id's and the version id's to supply to **compile** if you want to include libraries during compilation.
### `GET /api/shortlinkinfo/<linkid>` - return information about a given link
@@ -56,7 +58,8 @@ To specify a compilation request as a JSON document, post it as the appropriate
"filters": {
"filter": true
},
"tools": []
"tools": [],
"libraries": []
}
}
```
@@ -83,6 +86,9 @@ With the tools array you can ask CE to execute certain tools available for
For example: ```"tools": [{"id":"clangtidytrunk","args":"-checks=*"}]```
to execute clang-tidy with all checks enabled.
Libraries can be included by supplying the library id and versions in an array, for example:
```[{"id": "range-v3", "version": "trunk"}, {"id": "fmt", "version": "400"}]```
The text request is designed for simplicity for command-line clients like `curl`
```bash