Skip to content

Commit 5e42381

Browse files
committed
chore: cleanup & organize
1 parent e41a7e9 commit 5e42381

File tree

1 file changed

+10
-4
lines changed

1 file changed

+10
-4
lines changed

docs/APIContract.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,26 +9,29 @@ The base URL for an API should be: _baseURL_/_apiVersion_/ meaning even somethin
99
In order to provide a consistent API a metadata endpoint should be provided under _baseURL_/.well-known/pathofbuilding this endpoint should provide information about the API and the version of the API.
1010
Furthermore this may allow having custom endpoints for the API.
1111

12+
<details><summary><b>Specification</b></summary>
1213
| Feature | Field | Type | Description |
1314
| ---------------- | ------------- | ---------------- | ------------------------------------------------------------------------------------ |
1415
| League Filtering | league_filter | bool | This can be used to indicate whether the API supports filtering based on leagues |
1516
| Gem Filtering | gem_filter | bool | This can be used to indicate whether the API supports filtering based on gems |
1617
| Streams | streams | StreamInfo[] | A list of streams available to be queried against |
1718
| Update Builds | update_builds | UpdateBuildsInfo | Indicates if the API supports updating builds via PoB and which fields are supported |
1819

20+
</details>
21+
1922
### Types
2023

21-
#### StreamInfo
24+
<details><summary><b>StreamInfo</b></summary>
2225

2326
| Field | Type | Description |
2427
| ------- | ------ | ------------------------------- |
2528
| name | string | Name of the stream |
2629
| apiPath | string | API path to the stream endpoint |
2730

2831
apiPath might be changed to a generic endpoint such as `/v1/{stream}/builds`
32+
</details>
2933

30-
#### UpdateBuildsInfo
31-
34+
<details><summary><b>UpdateBuildsInfo</b></summary>
3235
| Field | Type | Description |
3336
| ---------- | -------- | ------------------------------------------------------ |
3437
| hasSupport | bool | indicates if the API supports updating external builds |
@@ -42,18 +45,21 @@ Example:
4245
"fields": ["description", "youtubeUrl"]
4346
}
4447
```
48+
</details>
49+
4550
## Version 1
4651

4752
### Response and Request types
4853

49-
#### BuildInfo
54+
<details><summary><b>BuildInfo</b></summary>
5055

5156
| Field | Type | Description |
5257
| ------------ | ------- | ----------------------------------- |
5358
| pobdata | string | The Path of Building data |
5459
| name | string | The name of the build |
5560
| lastModified | integer | The last modification timestamp |
5661
| buildId | string | The unique identifier for the build |
62+
</details>
5763

5864
### Endpoints
5965

0 commit comments

Comments
 (0)