plugins

Serializable plugins API request and response contracts.

class bedrock_server_manager.api.models.plugins.PluginInfo(*, has_settings: bool = False, has_global_settings: bool = False, has_server_settings: bool = False, enabled: bool, description: str = '', version: str = 'N/A', author: str = '', status: str = 'UNKNOWN')

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.GetPluginStatusesRequest

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.GetPluginStatusesResponse(*, status: Literal['success'] = 'success', message: str | None = None, plugins: dict[str, PluginInfo])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.SetPluginStatusRequest(*, target_plugin_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], enabled: bool)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.SetPluginStatusResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.ReloadSinglePluginRequest(*, target_plugin_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.ReloadSinglePluginResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.ReloadPluginsRequest

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.ReloadPluginsResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.TriggerExternalAppEventRequest(*, event_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], payload: dict[str, JsonValue] | None = None)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.EventDispatchSummary(*, event_id: str, listeners_called: int, failures: list[ListenerFailure])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.TriggerExternalAppEventResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str, details: EventDispatchSummary)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.PluginSettingsScope(*, scope: Literal['plugin', 'global', 'server'] = 'plugin', server_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, examples=['example'], metadata=[Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])] | None = None)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.GetPluginSettingRequest(*, scope: Literal['plugin', 'global', 'server'] = 'plugin', server_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, examples=['example'], metadata=[Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])] | None = None, key: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')])] | None = None)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.GetPluginSettingResponse(*, status: Literal['success'] = 'success', message: str | None = None, value: JsonValue)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.SetPluginSettingRequest(*, scope: Literal['plugin', 'global', 'server'] = 'plugin', server_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, examples=['example'], metadata=[Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])] | None = None, key: Annotated[str, FieldInfo(annotation=NoneType, required=True, metadata=[Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')])] | None = None, value: JsonValue)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.SetPluginSettingResponse(*, status: Literal['success', 'skipped', 'partial'] = 'success', message: str)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'json_schema_extra': <function action_response_schema>, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.GetPluginSettingsRequest(*, scope: Literal['plugin', 'global', 'server'] = 'plugin', server_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, examples=['example'], metadata=[Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])] | None = None, target_plugin_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.GetPluginSettingsResponse(*, status: Literal['success'] = 'success', message: str | None = None, settings: dict[str, JsonValue], settings_schema: dict[str, JsonValue] | None = None)

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.UpdatePluginSettingsRequest(*, scope: Literal['plugin', 'global', 'server'] = 'plugin', server_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, examples=['example'], metadata=[Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])] | None = None, target_plugin_name: Annotated[str, Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='.*\\S.*')], settings: dict[str, JsonValue])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

class bedrock_server_manager.api.models.plugins.PluginSettingsPayload(*, scope: Literal['plugin', 'global', 'server'] = 'plugin', server_name: Annotated[str, FieldInfo(annotation=NoneType, required=True, examples=['example'], metadata=[Strict(strict=True), MinLen(min_length=1), _PydanticGeneralMetadata(pattern='^[a-zA-Z0-9_-]+$')])] | None = None, settings: dict[str, JsonValue])

model_config = {'allow_inf_nan': False, 'extra': 'forbid', 'frozen': True, 'hide_input_in_errors': True, 'revalidate_instances': 'always', 'strict': True, 'validate_default': True}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].