diff --git a/clickhouse-admin/api/src/lib.rs b/clickhouse-admin/api/src/lib.rs index 9d4b771704..7a1d39e2fb 100644 --- a/clickhouse-admin/api/src/lib.rs +++ b/clickhouse-admin/api/src/lib.rs @@ -33,7 +33,7 @@ pub trait ClickhouseAdminKeeperApi { /// configuration set via this endpoint. #[endpoint { method = PUT, - path = "/gen-config-and-enable", + path = "/config", }] async fn generate_config_and_enable_svc( rqctx: RequestContext, @@ -45,7 +45,7 @@ pub trait ClickhouseAdminKeeperApi { /// and logs for consistency and recovery. #[endpoint { method = GET, - path = "/lgif", + path = "/4lw-lgif", }] async fn lgif( rqctx: RequestContext, @@ -64,7 +64,7 @@ pub trait ClickhouseAdminKeeperApi { /// Retrieve configuration information from a keeper node. #[endpoint { method = GET, - path = "/conf", + path = "/4lw-conf", }] async fn keeper_conf( rqctx: RequestContext, diff --git a/openapi/clickhouse-admin-keeper.json b/openapi/clickhouse-admin-keeper.json index 6eb46a1762..a9539f4c16 100644 --- a/openapi/clickhouse-admin-keeper.json +++ b/openapi/clickhouse-admin-keeper.json @@ -10,17 +10,17 @@ "version": "0.0.1" }, "paths": { - "/cluster-membership": { + "/4lw-conf": { "get": { - "summary": "Retrieve cluster membership information from a keeper node.", - "operationId": "keeper_cluster_membership", + "summary": "Retrieve configuration information from a keeper node.", + "operationId": "keeper_conf", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/ClickhouseKeeperClusterMembership" + "$ref": "#/components/schemas/KeeperConf" } } } @@ -34,17 +34,18 @@ } } }, - "/conf": { + "/4lw-lgif": { "get": { - "summary": "Retrieve configuration information from a keeper node.", - "operationId": "keeper_conf", + "summary": "Retrieve a logically grouped information file from a keeper node.", + "description": "This information is used internally by ZooKeeper to manage snapshots and logs for consistency and recovery.", + "operationId": "lgif", "responses": { "200": { "description": "successful operation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/KeeperConf" + "$ref": "#/components/schemas/Lgif" } } } @@ -58,28 +59,17 @@ } } }, - "/gen-config-and-enable": { - "put": { - "summary": "Generate a ClickHouse configuration file for a keeper node on a specified", - "description": "directory and enable the SMF service if not currently enabled.\n\nNote that we cannot start the keeper service until there is an initial configuration set via this endpoint.", - "operationId": "generate_config_and_enable_svc", - "requestBody": { - "content": { - "application/json": { - "schema": { - "$ref": "#/components/schemas/KeeperConfigurableSettings" - } - } - }, - "required": true - }, + "/cluster-membership": { + "get": { + "summary": "Retrieve cluster membership information from a keeper node.", + "operationId": "keeper_cluster_membership", "responses": { - "201": { - "description": "successful creation", + "200": { + "description": "successful operation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/KeeperConfig" + "$ref": "#/components/schemas/ClickhouseKeeperClusterMembership" } } } @@ -93,18 +83,28 @@ } } }, - "/lgif": { - "get": { - "summary": "Retrieve a logically grouped information file from a keeper node.", - "description": "This information is used internally by ZooKeeper to manage snapshots and logs for consistency and recovery.", - "operationId": "lgif", + "/config": { + "put": { + "summary": "Generate a ClickHouse configuration file for a keeper node on a specified", + "description": "directory and enable the SMF service if not currently enabled.\n\nNote that we cannot start the keeper service until there is an initial configuration set via this endpoint.", + "operationId": "generate_config_and_enable_svc", + "requestBody": { + "content": { + "application/json": { + "schema": { + "$ref": "#/components/schemas/KeeperConfigurableSettings" + } + } + }, + "required": true + }, "responses": { - "200": { - "description": "successful operation", + "201": { + "description": "successful creation", "content": { "application/json": { "schema": { - "$ref": "#/components/schemas/Lgif" + "$ref": "#/components/schemas/KeeperConfig" } } }