Skip to content

Commit 88065bd

Browse files
committed
docs: remove outdated images from API
1 parent 57bf066 commit 88065bd

File tree

1 file changed

+1
-9
lines changed

1 file changed

+1
-9
lines changed

docs/docs/configuration/http.mdx

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
dir-browser provides a lightweight HTTP API that allows you to retrieve directory listings and file metadata in JSON format. These endpoints are useful for building custom frontends or integrating with other services.
44

5-
:::info
6-
The `?ls` and `?info` endpoints require the `API` environment variable to be set to `true`.
7-
:::
8-
95
## Folder Listing (`?ls`)
106

117
To retrieve the contents of a directory as a JSON array, append `?ls` to any folder URL.
@@ -43,8 +39,6 @@ To retrieve the contents of a directory as a JSON array, append `?ls` to any fol
4339
]
4440
```
4541

46-
![Folder Listing API](https://github.com/adrianschubek/dir-browser/assets/19362349/72464d3e-6cf2-475e-86ca-45534ad9fdce)
47-
4842
## File Information (`?info`)
4943

5044
To retrieve detailed metadata for a specific file, append `?info` to the file URL.
@@ -65,8 +59,6 @@ To retrieve detailed metadata for a specific file, append `?info` to the file UR
6559
}
6660
```
6761

68-
![File Info API](https://github.com/adrianschubek/dir-browser/assets/19362349/4e7e9928-50c6-41ee-864f-144866d6fe5f)
69-
7062
## File Preview (`?preview`)
7163

7264
The `?preview` endpoint returns file metadata along with a content snippet for supported text-based files. This endpoint is used by the built-in popup previewer and **does not increment the download counter**.
@@ -102,7 +94,7 @@ The `?raw` endpoint serves the file's raw content directly. Similar to `?preview
10294

10395
## Configuration
10496

105-
The API endpoints can be enabled or disabled using the `API` environment variable. Disabling the API will also disable features that depend on it, such as the file previewer.
97+
The API endpoints can be enabled or disabled using the `API` environment variable. The `?ls` and `?info` endpoints require the `API` environment variable to be set to `true`.
10698

10799
import EnvConfig from "@site/src/components/EnvConfig";
108100

0 commit comments

Comments
 (0)