hyro/website
1
0
Fork 0
mirror of https://github.com/xHyroM/website.git synced 2024-11-25 08:11:05 +01:00
Code Issues Projects Releases Wiki Activity Actions

docs(distools-api): warnings

Browse source
This commit is contained in:
Jozef Steinhübl 2024-03-07 11:14:17 +01:00
parent 2f5125e4a0
commit 850b41c34d
No known key found for this signature in database
GPG key ID: E944BC293F5FF7E7
2 changed files with 15 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

5
docs/distools-api/eligible.md
View file

@ -5,6 +5,11 @@ description: How to check if a guild is eligible for an experiment
# Eligible
<div style="background-color: #e8c192; border-color: #fc8c03; color: #9c611a; padding-top: 0.7rem; padding-bottom: 0.7rem; padding-left: 0.7rem; padding-right: 0.8rem; border-left-width: 4px" role="alert">
<span style="font-weight: 700;">Be Warned</span><br />
<span>Unfortunately, this endpoint is not currently available due to capacity issues.</span>
</div>
This section of the documentation will cover how to check if a guild is eligible for an experiment.
Accessible on [https://api.distools.xhyrom.dev/v2/eligible](https://api.distools.xhyrom.dev/v2/eligible)

10
docs/distools-api/experiments.md
View file

@ -155,6 +155,11 @@ If the guild experiment hash (murmurhash v3 unsigned of `experiment_name:guild_i
You can fetch experiments from the API by sending a GET request to [https://api.distools.xhyrom.dev/v2/experiments](https://api.distools.xhyrom.dev/v2/experiments).
<div style="background-color: #e8c192; border-color: #fc8c03; color: #9c611a; padding-top: 0.7rem; padding-bottom: 0.7rem; padding-left: 0.7rem; padding-right: 0.8rem; border-left-width: 4px" role="alert">
<span style="font-weight: 700;">Be Warned</span><br />
<span>Unfortunately, due to capacity issues, the query parameters in the URL do not work. All experiments are always returned.</span>
</div>
**Query parameters:**
| Name | Type | Description |
| --------------------- | --------------- | ------------------------------------------------------------- |
@ -173,6 +178,11 @@ Returns array of [Experiment Object](#experiment-object)
## Fetching experiment
<div style="background-color: #e8c192; border-color: #fc8c03; color: #9c611a; padding-top: 0.7rem; padding-bottom: 0.7rem; padding-left: 0.7rem; padding-right: 0.8rem; border-left-width: 4px" role="alert">
<span style="font-weight: 700;">Be Warned</span><br />
<span>Unfortunately, this endpoint is not currently available due to capacity issues. As workaround, you can fetch all the experiments and filter yourself.</span>
</div>
You can fetch a specific experiment from the API by sending a GET request to [https://api.distools.xhyrom.dev/v2/experiments/:experimentId](https://api.distools.xhyrom.dev/v2/experiments/:experimentId).
You can use same query parameters as in [Fetching all experiments](#fetching-all-experiments)