feat: Exclude undocumented commands
This commit is contained in:
Ginger
parent
00eeeb78de
commit
ae28fe92d2
7 changed files with 14 additions and 220 deletions
|
|
@ -6,4 +6,4 @@ Commands for checking integrity
|
|||
|
||||
## `!admin check check-all-users`
|
||||
|
||||
_(no description)_
|
||||
Uses the iterator in `src/database/key_value/users.rs` to iterator over every user in our database (remote and local). Reports total count, any errors if there were any, etc
|
||||
|
|
|
|||
|
|
@ -137,19 +137,3 @@ List database files
|
|||
## `!admin debug tester`
|
||||
|
||||
Developer test stubs
|
||||
|
||||
### `!admin debug tester panic`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin debug tester failure`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin debug tester tester`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin debug tester timer`
|
||||
|
||||
_(no description)_
|
||||
|
|
|
|||
|
|
@ -36,15 +36,3 @@ Deletes all the local media from a local user on our server. This will always ig
|
|||
## `!admin media delete-all-from-server`
|
||||
|
||||
Deletes all remote media from the specified remote server. This will always ignore errors by default
|
||||
|
||||
## `!admin media get-file-info`
|
||||
|
||||
_(no description)_
|
||||
|
||||
## `!admin media get-remote-file`
|
||||
|
||||
_(no description)_
|
||||
|
||||
## `!admin media get-remote-thumbnail`
|
||||
|
||||
_(no description)_
|
||||
|
|
|
|||
|
|
@ -44,10 +44,6 @@ Iterator of the most recent presence updates that happened after the event with
|
|||
|
||||
rooms/alias.rs iterators and getters
|
||||
|
||||
### `!admin query room-alias resolve-local-alias`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-alias local-aliases-for-room`
|
||||
|
||||
Iterator of all our local room aliases for the room ID
|
||||
|
|
@ -60,98 +56,14 @@ Iterator of all our local aliases in our database with their room IDs
|
|||
|
||||
rooms/state_cache iterators and getters
|
||||
|
||||
### `!admin query room-state-cache server-in-room`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache room-servers`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache server-rooms`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache room-members`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache local-users-in-room`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache active-local-users-in-room`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache room-joined-count`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache room-invited-count`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache room-user-once-joined`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache room-members-invited`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache get-invite-count`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache get-left-count`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache rooms-joined`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache rooms-left`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache rooms-invited`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-state-cache invite-state`
|
||||
|
||||
_(no description)_
|
||||
|
||||
## `!admin query room-timeline`
|
||||
|
||||
rooms/timeline iterators and getters
|
||||
|
||||
### `!admin query room-timeline pdus`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query room-timeline last`
|
||||
|
||||
_(no description)_
|
||||
|
||||
## `!admin query globals`
|
||||
|
||||
globals.rs iterators and getters
|
||||
|
||||
### `!admin query globals database-version`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query globals current-count`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query globals last-check-for-announcements-id`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query globals signing-keys-for`
|
||||
|
||||
This returns an empty `Ok(BTreeMap<..>)` when there are no keys found for the server
|
||||
|
|
@ -184,94 +96,10 @@ appservice_id server_name user_id AND push_key
|
|||
|
||||
See src/service/sending/mod.rs for the definition of the `Destination` enum
|
||||
|
||||
### `!admin query sending get-latest-edu-count`
|
||||
|
||||
_(no description)_
|
||||
|
||||
## `!admin query users`
|
||||
|
||||
users.rs iterators and getters
|
||||
|
||||
### `!admin query users count-users`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users iter-users`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users iter-users2`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users password-hash`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users list-devices`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users list-devices-metadata`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-device-metadata`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-devices-version`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users count-one-time-keys`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-device-keys`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-user-signing-key`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-master-key`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-to-device-events`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-latest-backup`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-latest-backup-version`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-backup-algorithm`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-all-backups`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-room-backups`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-backup-session`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query users get-shared-rooms`
|
||||
|
||||
_(no description)_
|
||||
|
||||
## `!admin query resolver`
|
||||
|
||||
resolver service
|
||||
|
|
@ -296,14 +124,6 @@ Returns all the pushers for the user
|
|||
|
||||
short service
|
||||
|
||||
### `!admin query short short-event-id`
|
||||
|
||||
_(no description)_
|
||||
|
||||
### `!admin query short short-room-id`
|
||||
|
||||
_(no description)_
|
||||
|
||||
## `!admin query raw`
|
||||
|
||||
raw service
|
||||
|
|
|
|||
|
|
@ -4,9 +4,6 @@ use futures::StreamExt;
|
|||
|
||||
use crate::Context;
|
||||
|
||||
/// Uses the iterator in `src/database/key_value/users.rs` to iterator over
|
||||
/// every user in our database (remote and local). Reports total count, any
|
||||
/// errors if there were any, etc
|
||||
#[implement(Context, params = "<'_>")]
|
||||
pub(super) async fn check_all_users(&self) -> Result {
|
||||
let timer = tokio::time::Instant::now();
|
||||
|
|
|
|||
|
|
@ -8,5 +8,8 @@ use crate::admin_command_dispatch;
|
|||
#[admin_command_dispatch]
|
||||
#[derive(Debug, Subcommand)]
|
||||
pub enum CheckCommand {
|
||||
/// Uses the iterator in `src/database/key_value/users.rs` to iterator over
|
||||
/// every user in our database (remote and local). Reports total count, any
|
||||
/// errors if there were any, etc
|
||||
CheckAllUsers,
|
||||
}
|
||||
|
|
|
|||
|
|
@ -54,15 +54,17 @@ fn flatten_subcommands(command: &Command) -> Vec<Subcommand> {
|
|||
let description = command
|
||||
.get_long_about()
|
||||
.or_else(|| command.get_about())
|
||||
.map_or_else(|| "_(no description)_".to_owned(), ToString::to_string);
|
||||
.map(ToString::to_string);
|
||||
|
||||
subcommands.push(
|
||||
Subcommand {
|
||||
name,
|
||||
description,
|
||||
depth,
|
||||
}
|
||||
);
|
||||
if let Some(description) = description {
|
||||
subcommands.push(
|
||||
Subcommand {
|
||||
name,
|
||||
description,
|
||||
depth,
|
||||
}
|
||||
);
|
||||
}
|
||||
}
|
||||
|
||||
for command in command.get_subcommands() {
|
||||
|
|
|
|||
Loading…
Add table
Reference in a new issue