feat docs: use schemas for documentation in gRPC

Tests: протестировано в CI, проверено локально что все поля отображаются и форматируются приятно для глаза (или хотя бы как было раньше)
commit_hash:60b4cec9fe77021674d09980c12341e203a5941f

Author: apolukhin

.mapping.json

@@ -1743,6 +1743,7 @@
   "core/src/logging/tp_logger_test.cpp":"taxi/uservices/userver/core/src/logging/tp_logger_test.cpp",
   "core/src/logging/tp_logger_utils.cpp":"taxi/uservices/userver/core/src/logging/tp_logger_utils.cpp",
   "core/src/logging/tp_logger_utils.hpp":"taxi/uservices/userver/core/src/logging/tp_logger_utils.hpp",
+  "core/src/middlewares/factory_component_base.yaml":"taxi/uservices/userver/core/src/middlewares/factory_component_base.yaml",
   "core/src/middlewares/impl/middleware_pipeline_config.cpp":"taxi/uservices/userver/core/src/middlewares/impl/middleware_pipeline_config.cpp",
   "core/src/middlewares/impl/middlewares_graph.cpp":"taxi/uservices/userver/core/src/middlewares/impl/middlewares_graph.cpp",
   "core/src/middlewares/impl/middlewares_graph.hpp":"taxi/uservices/userver/core/src/middlewares/impl/middlewares_graph.hpp",
@@ -1753,6 +1754,7 @@
   "core/src/middlewares/pipeline.yaml":"taxi/uservices/userver/core/src/middlewares/pipeline.yaml",
   "core/src/middlewares/pipeline_test.cpp":"taxi/uservices/userver/core/src/middlewares/pipeline_test.cpp",
   "core/src/middlewares/runner.cpp":"taxi/uservices/userver/core/src/middlewares/runner.cpp",
+  "core/src/middlewares/runner_component_base.yaml":"taxi/uservices/userver/core/src/middlewares/runner_component_base.yaml",
   "core/src/net/blocking/get_addr_info.cpp":"taxi/uservices/userver/core/src/net/blocking/get_addr_info.cpp",
   "core/src/net/blocking/get_addr_info_test.cpp":"taxi/uservices/userver/core/src/net/blocking/get_addr_info_test.cpp",
   "core/src/os_signals/component.cpp":"taxi/uservices/userver/core/src/os_signals/component.cpp",

core/CMakeLists.txt

@@ -138,7 +138,9 @@ list(APPEND EMBED_FILES
     src/dynamic_config/updater/component.yaml
     src/engine/task_processors_load_monitor.yaml
     src/logging/component.yaml
+    src/middlewares/factory_component_base.yaml
     src/middlewares/pipeline.yaml
+    src/middlewares/runner_component_base.yaml
     src/server/component.yaml
     src/server/handlers/auth/auth_checker_settings_component.yaml
     src/server/handlers/auth/digest/auth_checker_settings_component.yaml

core/include/userver/middlewares/pipeline.hpp

@@ -70,10 +70,11 @@ std::string EndOfGroup() {
 
 /// @brief A base component to create middlewares pipeline.
 ///
-/// ## Static options:
-/// Name | Description | Default value
-/// ---- | ----------- | -------------
-/// middlewares | middlewares names and configs to use | `{}`
+/// ## Static options of @ref middlewares::impl::AnyMiddlewarePipelineComponent :
+/// @include{doc} scripts/docs/en/components_schema/core/src/middlewares/pipeline.md
+///
+/// Options inherited from @ref components::ComponentBase :
+/// @include{doc} scripts/docs/en/components_schema/core/src/components/impl/component_base.md
 ///
 /// ## Config example:
 ///

core/include/userver/middlewares/runner.hpp

@@ -50,11 +50,21 @@ void LogConfiguration(std::string_view component_name, const std::vector<std::st
 
 void LogValidateError(std::string_view middleware_name, const std::exception& e);
 
+yaml_config::Schema GetMiddlewareFactoryComponentBaseSchema();
+
+yaml_config::Schema GetRunnerComponentBaseSchema();
+
 }  // namespace impl
 
 /// @ingroup userver_base_classes
 ///
 /// @brief Base class for middleware factory component.
+///
+/// ## Static options of @ref middlewares::MiddlewareFactoryComponentBase :
+/// @include{doc} scripts/docs/en/components_schema/core/src/middlewares/factory_component_base.md
+///
+/// Options inherited from @ref components::ComponentBase :
+/// @include{doc} scripts/docs/en/components_schema/core/src/components/impl/component_base.md
 template <typename MiddlewareBaseType, typename HandlerInfo>
 class MiddlewareFactoryComponentBase : public impl::WithMiddlewareDependencyComponentBase {
 public:
@@ -86,16 +96,7 @@ class MiddlewareFactoryComponentBase : public impl::WithMiddlewareDependencyComp
     virtual yaml_config::Schema GetMiddlewareConfigSchema() const { return GetStaticConfigSchema(); }
 
     static yaml_config::Schema GetStaticConfigSchema() {
-        return yaml_config::MergeSchemas<components::ComponentBase>(R"(
-type: object
-description: base class for grpc-server middleware
-additionalProperties: false
-properties:
-    enabled:
-        type: string
-        description: the flag to enable/disable middleware in the pipeline
-        defaultDescription: true
-)");
+        return impl::GetMiddlewareFactoryComponentBaseSchema();
     }
 
     /// @cond
@@ -123,38 +124,19 @@ additionalProperties: false
 /// The Ordered list of middlewares `RunnerComponentBase` takes from Pipeline component.
 /// So, 'Pipeline' is responsible for the order of middlewares. `RunnerComponentBase` is responsible for creating
 /// middlewares and overriding configs.
+///
+/// ## Static options of @ref middlewares::RunnerComponentBase :
+/// @include{doc} scripts/docs/en/components_schema/core/src/middlewares/runner_component_base.md
+///
+/// Options inherited from @ref components::ComponentBase :
+/// @include{doc} scripts/docs/en/components_schema/core/src/components/impl/component_base.md
 template <typename MiddlewareBase, typename HandlerInfo>
 class RunnerComponentBase
     : public components::ComponentBase,
       public impl::PipelineCreatorInterface<MiddlewareBase, HandlerInfo> {
 public:
     static yaml_config::Schema GetStaticConfigSchema() {
-        return yaml_config::MergeSchemas<components::ComponentBase>(R"(
-type: object
-description: base class for all the gRPC service components
-additionalProperties: false
-properties:
-    disable-user-pipeline-middlewares:
-        type: boolean
-        description: flag to disable groups::User middlewares from pipeline
-        defaultDescription: false
-    disable-all-pipeline-middlewares:
-        type: boolean
-        description: flag to disable all middlewares from pipeline
-        defaultDescription: false
-    middlewares:
-        type: object
-        description: overloads of configs of middlewares per service
-        additionalProperties:
-            type: object
-            description: a middleware config
-            additionalProperties: true
-            properties:
-                enabled:
-                    type: boolean
-                    description: enable middleware in the list
-        properties: {}
-)");
+        return impl::GetRunnerComponentBaseSchema();
     }
 
 protected:

core/src/middlewares/factory_component_base.yaml

@@ -0,0 +1,8 @@
+type: object
+description: base class for grpc-server middleware
+additionalProperties: false
+properties:
+    enabled:
+        type: string
+        description: the flag to enable/disable middleware in the pipeline
+        defaultDescription: true

core/src/middlewares/pipeline.yaml

@@ -13,4 +13,5 @@ properties:
                 enabled:
                     type: boolean
                     description: enable middleware in the list
+                    defaultDescription: true
         properties: {}

core/src/middlewares/runner.cpp

@@ -7,9 +7,15 @@
 #include <userver/formats/yaml/value_builder.hpp>
 #include <userver/logging/log.hpp>
 #include <userver/yaml_config/impl/validate_static_config.hpp>
+#include <userver/yaml_config/merge_schemas.hpp>
 
 #include <userver/middlewares/groups.hpp>
 
+#ifndef ARCADIA_ROOT
+#include "generated/src/middlewares/factory_component_base.yaml.hpp"  // Y_IGNORE
+#include "generated/src/middlewares/runner_component_base.yaml.hpp"   // Y_IGNORE
+#endif
+
 USERVER_NAMESPACE_BEGIN
 
 namespace middlewares::impl {
@@ -34,7 +40,7 @@ MiddlewareDependencyBuilder MakeDefaultUserDependency() {
 }
 
 void LogConfiguration(std::string_view component_name, const std::vector<std::string>& names) {
-    LOG_INFO() << fmt::format("Middlewares configuration for {}: [{}]", component_name, fmt::join(names, ", "));
+    LOG_INFO("Middlewares configuration for {}: [{}]", component_name, fmt::join(names, ", "));
 }
 
 void LogValidateError(std::string_view middleware_name, const std::exception& e) {
@@ -46,6 +52,16 @@ void LogValidateError(std::string_view middleware_name, const std::exception& e)
         << e;
 }
 
+yaml_config::Schema GetMiddlewareFactoryComponentBaseSchema() {
+    return yaml_config::MergeSchemasFromResource<
+        components::ComponentBase>("src/middlewares/factory_component_base.yaml");
+}
+
+yaml_config::Schema GetRunnerComponentBaseSchema() {
+    return yaml_config::MergeSchemasFromResource<components::ComponentBase>("src/middlewares/runner_component_base.yaml"
+    );
+}
+
 }  // namespace middlewares::impl
 
 USERVER_NAMESPACE_END

core/src/middlewares/runner_component_base.yaml

@@ -0,0 +1,24 @@
+type: object
+description: base class for all the gRPC service components
+additionalProperties: false
+properties:
+    disable-user-pipeline-middlewares:
+        type: boolean
+        description: flag to disable groups::User middlewares from pipeline
+        defaultDescription: false
+    disable-all-pipeline-middlewares:
+        type: boolean
+        description: flag to disable all middlewares from pipeline
+        defaultDescription: false
+    middlewares:
+        type: object
+        description: overloads of configs of middlewares per service
+        additionalProperties:
+            type: object
+            description: a middleware config
+            additionalProperties: true
+            properties:
+                enabled:
+                    type: boolean
+                    description: enable middleware in the list
+        properties: {}

grpc/include/userver/ugrpc/client/client_factory_component.hpp

@@ -20,8 +20,6 @@ using MiddlewareRunnerComponentBase = USERVER_NAMESPACE::middlewares::RunnerComp
 
 }  // namespace impl
 
-// clang-format off
-
 /// @ingroup userver_components
 ///
 /// @brief Provides a ClientFactory in the component system
@@ -43,28 +41,20 @@ using MiddlewareRunnerComponentBase = USERVER_NAMESPACE::middlewares::RunnerComp
 /// ## Service config
 /// As per https://github.com/grpc/grpc/blob/master/doc/service_config.md
 /// service config should be distributed via the name resolution process.
-/// We allow setting default service_config: pass desired JSON literal
-/// to `default-service-config` parameter
+/// We allow setting default service_config: pass desired JSON literal to `default-service-config` parameter
 ///
-/// ## Static options:
-/// The default component name for static config is `"grpc-client-factory"`.
+/// ## Static options of @ref ugrpc::client::ClientFactoryComponent :
+/// @include{doc} scripts/docs/en/components_schema/grpc/src/ugrpc/client/client_factory_component.md
 ///
-/// Name | Description | Default value
-/// ---- | ----------- | -------------
-/// auth-type | authentication method, see @ref grpc_ssl_authentication "Authentication" | -
-/// ssl-credentials-options | TLS/SSL options, see @ref grpc_ssl_authentication "Authentication" | -
-/// retry-config | retry configuration for outgoing RPCs | {}
-/// channel-args | a map of channel arguments, see gRPC Core docs | {}
-/// default-service-config | default service config, see above | -
-/// channel-count | Number of underlying grpc::Channel objects | 1
-/// middlewares | middlewares names to use | -
-/// disable-user-pipeline-middlewares | a flag to disable groups::User middlewares from pipeline | false
-/// disable-all-pipeline-middlewares | a flag to disable all middlewares from the pipeline | false
+/// Options inherited from @ref middlewares::RunnerComponentBase :
+/// @include{doc} scripts/docs/en/components_schema/core/src/middlewares/runner_component_base.md
+///
+/// Options inherited from @ref components::ComponentBase :
+/// @include{doc} scripts/docs/en/components_schema/core/src/components/impl/component_base.md
+///
+/// The default component name for static config is `"grpc-client-factory"`.
 ///
 /// @see https://grpc.github.io/grpc/core/group__grpc__arg__keys.html
-
-// clang-format on
-
 class ClientFactoryComponent final : public impl::MiddlewareRunnerComponentBase {
 public:
     /// @ingroup userver_component_names

grpc/include/userver/ugrpc/client/common_component.hpp

@@ -17,29 +17,23 @@ USERVER_NAMESPACE_BEGIN
 
 namespace ugrpc::client {
 
-// clang-format off
-
 /// @ingroup userver_components
 ///
 /// @brief Contains common machinery that's required for all ugrpc clients
 ///
-/// ## Static options:
-/// The component name for static config is `"grpc-client-common"`.
+/// ## Static options of @ref ugrpc::client::CommonComponent :
+/// @include{doc} scripts/docs/en/components_schema/grpc/src/ugrpc/client/common_component.md
 ///
-/// Name | Description | Default value
-/// ---- | ----------- | -------------
-/// blocking-task-processor | the task processor for blocking channel creation | -
-/// native-log-level | min log level for the native gRPC library | 'error'
-/// proxy-address | proxy server address | ''
-/// servicemesh-settings | settings for service mesh integration | -
+/// Options inherited from @ref components::ComponentBase :
+/// @include{doc} scripts/docs/en/components_schema/core/src/components/impl/component_base.md
+///
+/// The component name for static config is `"grpc-client-common"`.
 ///
 /// @see ugrpc::client::ClientFactoryComponent
-
-// clang-format on
 class CommonComponent final : public components::ComponentBase {
 public:
     /// @ingroup userver_component_names
-    /// @brief The default name of ugrpc::client::CommonComponent
+    /// @brief The default name of @ref ugrpc::client::CommonComponent
     static constexpr std::string_view kName = "grpc-client-common";
 
     CommonComponent(const components::ComponentConfig& config, const components::ComponentContext& context);