From 850b41c34dbeaf4bde5b54ffcf455efd77fc5558 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jozef=20Steinh=C3=BCbl=20=28xHyroM=29?= Date: Thu, 7 Mar 2024 11:14:17 +0100 Subject: [PATCH] docs(distools-api): warnings --- docs/distools-api/eligible.md | 5 +++++ docs/distools-api/experiments.md | 10 ++++++++++ 2 files changed, 15 insertions(+) diff --git a/docs/distools-api/eligible.md b/docs/distools-api/eligible.md index 83b560f..be4ab6b 100644 --- a/docs/distools-api/eligible.md +++ b/docs/distools-api/eligible.md @@ -5,6 +5,11 @@ description: How to check if a guild is eligible for an experiment # Eligible +
+ Be Warned
+ Unfortunately, this endpoint is not currently available due to capacity issues. +
+ 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) diff --git a/docs/distools-api/experiments.md b/docs/distools-api/experiments.md index 4ac11c1..de592e6 100644 --- a/docs/distools-api/experiments.md +++ b/docs/distools-api/experiments.md @@ -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). +
+ Be Warned
+ Unfortunately, due to capacity issues, the query parameters in the URL do not work. All experiments are always returned. +
+ **Query parameters:** | Name | Type | Description | | --------------------- | --------------- | ------------------------------------------------------------- | @@ -173,6 +178,11 @@ Returns array of [Experiment Object](#experiment-object) ## Fetching experiment +
+ Be Warned
+ Unfortunately, this endpoint is not currently available due to capacity issues. As workaround, you can fetch all the experiments and filter yourself. +
+ 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)