refactor: rename discord-experiments-api to distools-api in docs

This commit is contained in:
xHyroM 2023-06-17 20:36:40 +02:00
parent 9df3a89e9b
commit 2a30faa840
No known key found for this signature in database
GPG key ID: BE0423F386C436AA
6 changed files with 29 additions and 21 deletions

View file

@ -13,23 +13,23 @@ export interface SidebarItem {
export const docs: Docs = { export const docs: Docs = {
sidebar: [ sidebar: [
{ {
text: "Discord Experiments API", text: "Discord Tools API",
items: [ items: [
{ {
text: "Introduction", text: "Introduction",
link: "/docs/discord-experiments-api/introduction", link: "/docs/distools-api/introduction",
}, },
{ {
text: "Experiments", text: "Experiments",
link: "/docs/discord-experiments-api/experiments", link: "/docs/distools-api/experiments",
}, },
{ {
text: "Eligible", text: "Eligible",
link: "/docs/discord-experiments-api/eligible", link: "/docs/distools-api/eligible",
}, },
{ {
text: "Stats", text: "Stats",
link: "/docs/discord-experiments-api/stats", link: "/docs/distools-api/stats",
}, },
], ],
}, },

View file

@ -7,7 +7,7 @@ description: How to check if a guild is eligible for an experiment
This section of the documentation will cover how to check if a guild is eligible for an experiment. This section of the documentation will cover how to check if a guild is eligible for an experiment.
Accessible on [https://api.discord-experiments.xhyrom.dev/v2/eligible](https://api.discord-experiments.xhyrom.dev/v2/eligible) Accessible on [https://api.distools.xhyrom.dev/v2/eligible](https://api.distools.xhyrom.dev/v2/eligible)
## Eligible Object ## Eligible Object
@ -26,7 +26,7 @@ Represents the eligibility of a guild for an experiment
## Checking eligibility ## Checking eligibility
You can check if a guild is eligible for an experiment by sending a POST request to [https://api.discord-experiments.xhyrom.dev/v2/eligible](https://api.discord-experiments.xhyrom.dev/v2/eligible) You can check if a guild is eligible for an experiment by sending a POST request to [https://api.distools.xhyrom.dev/v2/eligible](https://api.distools.xhyrom.dev/v2/eligible)
**Body:** **Body:**
@ -38,7 +38,7 @@ You can check if a guild is eligible for an experiment by sending a POST request
\* Only `id`, `features` and `member_count` fields are checked and `id` is required \* Only `id`, `features` and `member_count` fields are checked and `id` is required
``` ```
POST https://api.discord-experiments.xhyrom.dev/v2/eligible POST https://api.distools.xhyrom.dev/v2/eligible
{ {
"experiment_id": "2023-03_clyde_ai", "experiment_id": "2023-03_clyde_ai",

View file

@ -7,7 +7,7 @@ description: How to fetch experiments from the API
This section of the documentation will cover how to fetch experiments from the API. This section of the documentation will cover how to fetch experiments from the API.
Accessible on [https://api.discord-experiments.xhyrom.dev/v2/experiments](https://api.discord-experiments.xhyrom.dev/v2/experiments) Accessible on [https://api.distools.xhyrom.dev/v2/experiments](https://api.distools.xhyrom.dev/v2/experiments)
## Experiment Object ## Experiment Object
@ -153,7 +153,7 @@ If the guild experiment hash (murmurhash v3 unsigned of `experiment_name:guild_i
## Fetching all experiments ## Fetching all experiments
You can fetch experiments from the API by sending a GET request to [https://api.discord-experiments.xhyrom.dev/v2/experiments](https://api.discord-experiments.xhyrom.dev/v2/experiments). 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).
**Query parameters:** **Query parameters:**
| Name | Type | Description | | Name | Type | Description |
@ -166,19 +166,19 @@ You can fetch experiments from the API by sending a GET request to [https://api.
\* If you want multiple kinds, you can separate them with a comma (,) \* If you want multiple kinds, you can separate them with a comma (,)
``` ```
GET https://api.discord-experiments.xhyrom.dev/v2/experiments GET https://api.distools.xhyrom.dev/v2/experiments
``` ```
Returns array of [Experiment Object](#experiment-object) Returns array of [Experiment Object](#experiment-object)
## Fetching experiment ## Fetching experiment
You can fetch a specific experiment from the API by sending a GET request to [https://api.discord-experiments.xhyrom.dev/v2/experiments/:experimentId](https://api.discord-experiments.xhyrom.dev/v2/experiments/:experimentId). 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) You can use same query parameters as in [Fetching all experiments](#fetching-all-experiments)
``` ```
GET https://api.discord-experiments.xhyrom.dev/v2/experiments/:experimentId GET https://api.distools.xhyrom.dev/v2/experiments/:experimentId
``` ```
Returns [Experiment Object](#experiment-object) Returns [Experiment Object](#experiment-object)

View file

@ -1,17 +1,17 @@
--- ---
title: Introduction title: Introduction
description: Introduction to the Discord Experiments API description: Introduction to the Distools API
--- ---
# Introduction # Introduction
This section of the documentation will cover the basics of the Discord Experiments API, and how to use it. This section of the documentation will cover the basics of the Distools API, and how to use it.
Accessible on [https://api.discord-experiments.xhyrom.dev/v2](https://api.discord-experiments.xhyrom.dev/v2) Accessible on [https://api.distools.xhyrom.dev/v2](https://api.distools.xhyrom.dev/v2)
## What is the Discord Experiments API? ## What is the Distools API?
It's about the Discord Experiments API, which allows you to get information about Discord's experiments. It's a public API, so you don't need any token to use it. It's about the Distools API, which allows you to get information about Discord's experiments. It's a public API, so you don't need any token to use it.
## How it works? ## How it works?

View file

@ -7,7 +7,7 @@ description: Get stats from the API
This section of the documentation will cover how to get stats from the API. This section of the documentation will cover how to get stats from the API.
Accessible on [https://api.discord-experiments.xhyrom.dev/v2/stats](https://api.discord-experiments.xhyrom.dev/v2/stats) Accessible on [https://api.distools.xhyrom.dev/v2/stats](https://api.distools.xhyrom.dev/v2/stats)
## Stats Object ## Stats Object
@ -35,10 +35,10 @@ Represents number of experiments by kind
## Fetching stats ## Fetching stats
You can fetch stats from the API by sending a GET request to [https://api.discord-experiments.xhyrom.dev/v2/stats](https://api.discord-experiments.xhyrom.dev/v2/stats) You can fetch stats from the API by sending a GET request to [https://api.distools.xhyrom.dev/v2/stats](https://api.distools.xhyrom.dev/v2/stats)
``` ```
GET https://api.discord-experiments.xhyrom.dev/v2/stats GET https://api.distools.xhyrom.dev/v2/stats
``` ```
Returns a [stats object](#stats-object) Returns a [stats object](#stats-object)

View file

@ -19,6 +19,14 @@
"source": "/docs/", "source": "/docs/",
"destination": "/docs/discord-experiments-api/introduction" "destination": "/docs/discord-experiments-api/introduction"
}, },
{
"source": "/docs/discord-experiments-api",
"destination": "/docs/distools-api/introduction"
},
{
"source": "/docs/discord-experiments-api/:name",
"destination": "/docs/distools-api/:name"
},
{ {
"source": "/blog/:name", "source": "/blog/:name",
"destination": "/blog/posts/:name" "destination": "/blog/posts/:name"