Skip to content

Commit

Permalink
add new posgresql docs && update mysql docs (#38)
Browse files Browse the repository at this point in the history 
Co-authored-by: Vladislav Kolesnikov <[email protected]>
  • Loading branch information
@vladqa
vladqa and Vladislav Kolesnikov committed Feb 28, 2024
1 parent 6fc5a4c commit 8cb706d
Show file tree
Hide file tree
Showing 2 changed files with 117 additions and 22 deletions.
41 changes: 21 additions & 20 deletions proto/v1/mysql.proto
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,24 +8,24 @@ import "cloud/proto/v1/structures.proto";
//
// Предоставляет набор методов для работы с базами данных, доступами и параметрами МySQL.
service MysqlService {
// Получить параметры MySQL
// Получить конфигурацию MySQL
//
// Возвращает список текущих параметров MySQL.
// Возвращает список текущих параметров конфигурации MySQL.
//
// Для получения доступных идентификаторов сервисов `service_id` необходимо использовать метод
// "Получить информацию о сервисах" из API "Управляемые сервисы".
// "Получить информацию о сервисах" из API "Управляемые сервисы" -> "Управление сервисами".
rpc getConfig(GetConfigRequest) returns (GetConfigResponse) {
option (google.api.http) = {
get: "/v1/cloud/mysql/{service_id}/config",
};
}

// Изменить параметры MySQL
// Изменить конфигурацию MySQL
//
// Меняет параметры MySQL на заданные.
// Изменяет параметры конфигурации MySQL на заданные.
//
// Для получения доступных идентификаторов сервисов `service_id` необходимо использовать метод
// "Получить информацию о сервисах" из API "Управляемые сервисы".
// "Получить информацию о сервисах" из API "Управляемые сервисы" -> "Управление сервисами".
rpc setConfig(SetConfigRequest) returns (SetConfigResponse) {
option (google.api.http) = {
put: "/v1/cloud/mysql/{service_id}/config",
Expand All @@ -38,7 +38,7 @@ service MysqlService {
// Возвращает список баз данных в MySQL.
//
// Для получения доступных идентификаторов сервисов `service_id` необходимо использовать метод
// "Получить информацию о сервисах" из API "Управляемые сервисы".
// "Получить информацию о сервисах" из API "Управляемые сервисы" -> "Управление сервисами".
rpc getDbList(GetDbListRequest) returns (GetDbListResponse) {
option (google.api.http) = {
get: "/v1/cloud/mysql/{service_id}/db",
Expand All @@ -50,7 +50,7 @@ service MysqlService {
// Создает новую базу данных в MySQL.
//
// Для получения доступных идентификаторов сервисов `service_id` необходимо использовать метод
// "Получить информацию о сервисах" из API "Управляемые сервисы".
// "Получить информацию о сервисах" из API "Управляемые сервисы" -> "Управление сервисами".
rpc createDb(CreateDbRequest) returns (CreateDbResponse) {
option (google.api.http) = {
post: "/v1/cloud/mysql/{service_id}/db",
Expand All @@ -63,10 +63,10 @@ service MysqlService {
// Удаляет указанную базу данных из MySQL со всеми хранящимися в ней данными.
//
// Для получения доступных идентификаторов сервисов `service_id` необходимо использовать метод
// "Получить информацию о сервисах" из API "Управляемые сервисы".
// "Получить информацию о сервисах" из API "Управляемые сервисы" -> "Управление сервисами".
//
// Для получения доступных имён баз данных `db_name` необходимо использовать метод
// "Получить список баз данных" из API "Управляемые сервисы".
// "Получить список баз данных" из API "Управляемые сервисы" -> "Управление MySQL".
rpc removeDb(RemoveDbRequest) returns (RemoveDbResponse) {
option (google.api.http) = {
delete: "/v1/cloud/mysql/{service_id}/db/{db_name}",
Expand All @@ -78,10 +78,10 @@ service MysqlService {
// Создает отдельный доступ для базы данных.
//
// Для получения доступных идентификаторов сервисов `service_id` необходимо использовать метод
// "Получить информацию о сервисах" из API "Управляемые сервисы".
// "Получить информацию о сервисах" из API "Управляемые сервисы" -> "Управление сервисами".
//
// Для получения доступных имён баз данных `db_name` необходимо использовать метод
// "Получить список баз данных" из API "Управляемые сервисы".
// "Получить список баз данных" из API "Управляемые сервисы" -> "Управление MySQL".
rpc createAccess(CreateAccessRequest) returns (CreateAccessResponse) {
option (google.api.http) = {
post: "/v1/cloud/mysql/{service_id}/db/{db_name}/access",
Expand All @@ -94,10 +94,10 @@ service MysqlService {
// Удаляет указанный отдельный доступ для базы данных.
//
// Для получения доступных идентификаторов сервисов `service_id` необходимо использовать метод
// "Получить информацию о сервисах" из API "Управляемые сервисы".
// "Получить информацию о сервисах" из API "Управляемые сервисы" -> "Управление сервисами".
//
// Для получения доступных имён баз данных `db_name` и хостов `host` необходимо использовать метод
// "Получить список баз данных" из API "Управляемые сервисы".
// "Получить список баз данных" из API "Управляемые сервисы" -> "Управление MySQL".
rpc removeAccess(RemoveAccessRequest) returns (RemoveAccessResponse) {
option (google.api.http) = {
delete: "/v1/cloud/mysql/{service_id}/db/{db_name}/access/{host}",
Expand All @@ -109,26 +109,27 @@ service MysqlService {
// Изменяет пароль для указанного доступа к базе данных.
//
// Для получения доступных идентификаторов сервисов `service_id` необходимо использовать метод
// "Получить информацию о сервисах" из API "Управляемые сервисы".
// "Получить информацию о сервисах" из API "Управляемые сервисы" -> "Управление сервисами".
//
// Для получения доступных имён баз данных `db_name` и хостов `host` необходимо использовать метод
// "Получить список баз данных" из API "Управляемые сервисы".
// "Получить список баз данных" из API "Управляемые сервисы" -> "Управление MySQL".
rpc changeAccessPassword(ChangeAccessPasswordRequest) returns (ChangeAccessPasswordResponse) {
option (google.api.http) = {
patch: "/v1/cloud/mysql/{service_id}/db/{db_name}/access/{host}",
body: "*"
};
}

// Обновить описание базы данных
// Изменить информацию о базе данных
//
// Изменяет описание базы данных.
// Обновляет следующую информацию о базе данных:
// - Описание базы данных
//
// Для получения доступных идентификаторов сервисов `service_id` необходимо использовать метод
// "Получить информацию о сервисах" из API "Управляемые сервисы".
// "Получить информацию о сервисах" из API "Управляемые сервисы" -> "Управление сервисами".
//
// Для получения доступных имён баз данных `db_name` необходимо использовать метод
// "Получить список баз данных" из API "Управляемые сервисы".
// "Получить список баз данных" из API "Управляемые сервисы" -> "Управление MySQL".
rpc updateDb(UpdateDbRequest) returns (UpdateDbResponse){
option (google.api.http) = {
patch: "/v1/cloud/mysql/{service_id}/db/{db_name}",
Expand Down
Loading

0 comments on commit 8cb706d

Please sign in to comment.