Skip to content

Commit

Permalink
Add note about API not supporting external files (#4483)
Browse files Browse the repository at this point in the history
  • Loading branch information
RubenRBS authored and mattgodbolt committed Jan 24, 2023
1 parent 79e4435 commit cb1b3af
Showing 1 changed file with 9 additions and 0 deletions.
9 changes: 9 additions & 0 deletions docs/API.md
Expand Up @@ -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
Expand Down

0 comments on commit cb1b3af

Please sign in to comment.