Skip to content

Commit b7d0db1

Browse files
write minimal docs for the web API
1 parent 9cf11ff commit b7d0db1

1 file changed

Lines changed: 44 additions & 0 deletions

File tree

pages/webapi.md

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
\page webapi api.raidcore.gg
2+
api.raidcore.gg supports the following endpoints
3+
4+
### `GET api.raidcore.gg/addonlibrary`
5+
returns an array of JSON objects matching the following type
6+
```ts
7+
interface Addon {
8+
id: number;
9+
name: string;
10+
author: string;
11+
description: string;
12+
download: URL;
13+
filename: string;
14+
addon_policy_tier: number;
15+
tags: string[];
16+
}
17+
```
18+
19+
### `GET api.raidcore.gg/arcdpslibrary`
20+
returns an array of objects matching the following type
21+
```ts
22+
type Addon = {
23+
id: number;
24+
name: string;
25+
author: string;
26+
description: string;
27+
download: URL;
28+
filename: string;
29+
addon_policy_tier: number;
30+
tags: string[];
31+
}
32+
```
33+
34+
### `GET api.raidcore.gg/nexusversion`
35+
returns an object matching the following type
36+
```ts
37+
interface NexusVersion{
38+
Major: number;
39+
Minor: number;
40+
Build: number;
41+
Revision: number;
42+
Changelog: string;
43+
}
44+
```

0 commit comments

Comments
 (0)