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

Add note about API not supporting external files (#4483)

Browse Source
This commit is contained in:
Rubén Rincón Blanco
2022-12-24 19:46:45 +01:00
committed by GitHub
parent b5ba2c0d7d
commit 2e85575145
1 changed files with 9 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

9
docs/API.md
View File

@@ -131,6 +131,15 @@ Libraries can be marked to have their directories available when including their
supplying the library ids and versions in an array. The id's to supply can be found with the
`/api/libraries/<language-id>`
Note that using external header files of the type:
```
#include <https://some-url.to/a-file.h>
```
is not supported for this endpoint for security reasons.
The feature for the site is handled client-side, as the compilation nodes have no internet access.
### `GET /api/formats` - return available code formatters
Returns a list of code formatters. The API returns an array of formatter objects which have the following object