Skip to content

Commit 8d660b8

Browse files
committed
docs: remove endpoint doc
The endpoint was removed.
1 parent a5e745e commit 8d660b8

File tree

1 file changed

+0
-29
lines changed
  • src/web/api/server/v1/contexts/settings

1 file changed

+0
-29
lines changed

src/web/api/server/v1/contexts/settings/mod.rs

-29
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,6 @@
55
//! # Endpoints
66
//!
77
//! - [Get all settings](#get-all-settings)
8-
//! - [Update all settings](#update-all-settings)
98
//! - [Get site name](#get-site-name)
109
//! - [Get public settings](#get-public-settings)
1110
//!
@@ -102,34 +101,6 @@
102101
//! Refer to the [`TorrustIndex`](crate::config::Settings)
103102
//! struct for more information about the response attributes.
104103
//!
105-
//! # Update all settings
106-
//!
107-
//! **NOTICE**: This endpoint to update the settings does not work when you use
108-
//! environment variables to configure the application. You need to use a
109-
//! configuration file instead. Because settings are persisted in that file.
110-
//! Refer to the issue [#144](https://github.com/torrust/torrust-index/issues/144)
111-
//! for more information.
112-
//!
113-
//! `POST /v1/settings`
114-
//!
115-
//! **Example request**
116-
//!
117-
//! ```bash
118-
//! curl \
119-
//! --header "Content-Type: application/json" \
120-
//! --header "Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyIjp7InVzZXJfaWQiOjEsInVzZXJuYW1lIjoiaW5kZXhhZG1pbiIsImFkbWluaXN0cmF0b3IiOnRydWV9LCJleHAiOjE2ODYyMTU3ODh9.4k8ty27DiWwOk4WVcYEhIrAndhpXMRWnLZ3i_HlJnvI" \
121-
//! --request POST \
122-
//! --data '{"website":{"name":"Torrust"},"tracker":{"url":"udp://localhost:6969","mode":"public","api_url":"http://localhost:1212/","token":"MyAccessToken","token_valid_seconds":7257600},"net":{"port":3001,"base_url":null},"auth":{"min_password_length":6,"max_password_length":64,"secret_key":"MaxVerstappenWC2021"},"database":{"connect_url":"sqlite://./storage/database/data.db?mode=rwc"},"mail":{"from":"example@email.com","reply_to":"noreply@email.com","username":"","password":"","server":"","port":25},"image_cache":{"max_request_timeout_ms":1000,"capacity":128000000,"entry_size_limit":4000000,"user_quota_period_seconds":3600,"user_quota_bytes":64000000},"api":{"default_torrent_page_size":10,"max_torrent_page_size":30},"tracker_statistics_importer":{"torrent_info_update_interval":3600}}' \
123-
//! "http://127.0.0.1:3001/v1/settings"
124-
//! ```
125-
//!
126-
//! The response contains the settings that were updated.
127-
//!
128-
//! **Resource**
129-
//!
130-
//! Refer to the [`TorrustIndex`](crate::config::Settings)
131-
//! struct for more information about the response attributes.
132-
//!
133104
//! # Get site name
134105
//!
135106
//! `GET /v1/settings/name`

0 commit comments

Comments
 (0)