Skip to content

Getting the list of pages of the wiki

Théandre Bourry edited this page Jun 21, 2023 · 1 revision

To get the list of pages available in the wiki, you should make a call to the route

GET api/list

This will read the server's folder containing the markdown files for each page, and return a list of small json objects containing the link to every page, as well as their display names.

Route infos

Authorizations

This route is accessible with no authorization at all.

Parameters

Mandatory

There are no mandatory parameters to give for this route.

Optional

There are no optional parameters to give for this route.

Request body

As a GET request, the body should remain empty

Response

When successful, this route should return a 200 HTTP code.
This is how the body of the response will look:

[
    {
        "url": "?File_Name1",
        "name": "File Name1"
    },
    {
        "url": "?File_Name2",
        "name": "File Name2"
    },
    {
        "url": "?...",
        "name": "..."
    },

    ...
]