Crate synapse_admin_api

Crate synapse_admin_api 

Source
Expand description

Serializable types for the requests and responses for each endpoint in the synapse admin API.

§Compile-time cfg settings

These settings are accepted at compile time to configure the generated code. They can be set as --cfg={key}={value} using RUSTFLAGS or .cargo/config.toml (under [build] -> rustflags = ["..."]).

  • ruma_identifiers_storage – Choose the inner representation of Owned* wrapper types for identifiers. By default they use Box, setting the value to Arc makes them use Arc.
  • ruma_unstable_exhaustive_types – Most types in synapse-admin-api are marked as non-exhaustive to avoid breaking changes when new fields are added in the API. This setting compiles all types as exhaustive. By enabling this feature you opt out of all semver guarantees synapse-admin-api otherwise provides.

Modules§

account_validity
Endpoints in the /_synapse/admin/v<x>/account_validity/ scope.
background_updates
Endpoints in the /_synapse/admin/v<x>/background_updates/ scope to manage background updates.
experimental_features
register_users
Endpoints in the /_synapse/admin/v<x>/register/ scope.
room_membership
Endpoints in the /_synapse/admin/v<x>/join/ scope.
rooms
Endpoints in the /_synapse/admin/v<x>/rooms/ scope.
users
Endpoints in the /_synapse/admin/v<x>/users/ scope.
version
Endpoints for obtaining version information.