feat docs: use schemas in core for docs in more cases

Tests: протестировано локально
commit_hash:8e1b78f04004d85606046c5d11c468ed2c828ecc

Author: apolukhin

clickhouse/src/storages/clickhouse/component.yaml

@@ -4,25 +4,30 @@ additionalProperties: false
 properties:
     secdist_alias:
         type: string
-        description: name of the key in secdist config
-        defaultDescription: '<components name>'
+        description: |
+            Name of the key in secdist config.
+
+            Default: '<components name>'
     initial_pool_size:
         type: integer
         description: number of connections created initially
-        defaultDescription: 5
+        default: 5
     max_pool_size:
         type: integer
         description: maximum number of created connections
-        defaultDescription: 10
+        default: 10
     queue_timeout:
         type: string
         description: client waiting for a free connection time limit
-        defaultDescription: 1s
+        default: 1s
     use_secure_connection:
         type: boolean
         description: whether to use TLS for connections
-        defaultDescription: true
+        default: true
     compression:
         type: string
-        description: compression method to use (none / lz4)
-        defaultDescription: none
+        description: compression method to use
+        default: none
+        enum:
+          - none
+          - lz4

cmake/UserverGenerateComponentsSchemaDocs.cmake

@@ -1,5 +1,5 @@
 function(_userver_add_target_gen_component_schemas_docs)
-    file(GLOB_RECURSE YAML_FILENAMES */src/*.yaml)
+    file(GLOB_RECURSE YAML_FILENAMES */src/*.yaml */static_configs/*.yaml)
 
     add_custom_target(
         userver-gen-components-schema-docs

core/include/userver/clients/dns/component.hpp

@@ -11,34 +11,19 @@ USERVER_NAMESPACE_BEGIN
 
 namespace clients::dns {
 
-// clang-format off
-
 /// @ingroup userver_components
 ///
 /// @brief Caching DNS resolver component.
 ///
 /// Returned references to clients::dns::Resolver live for a lifetime
 /// of the component and are safe for concurrent use.
 ///
-/// ## Static options:
-/// Name | Description | Default value
-/// ---- | ----------- | -------------
-/// fs-task-processor | task processor for disk I/O operations | engine::current_task::GetBlockingTaskProcessor()
-/// hosts-file-path | path to the `hosts` file | /etc/hosts
-/// hosts-file-update-interval | `hosts` file cache reload interval | 5m
-/// network-timeout | timeout for network requests | 1s
-/// network-attempts | number of attempts for network requests | 1
-/// network-custom-servers | list of name servers to use | from `/etc/resolv.conf`
-/// cache-ways | number of ways for network cache | 16
-/// cache-size-per-way | size of each way of network cache | 256
-/// cache-max-reply-ttl | TTL limit for network replies caching | 5m
-/// cache-failure-ttl | TTL for network failures caching | 5s
+/// ## Static options of clients::dns::Component :
+/// @include{doc} scripts/docs/en/components_schema/core/static_configs/dns_client.md
 ///
 /// ## Static configuration example:
 ///
 /// @snippet components/common_component_list_test.cpp  Sample dns client component config
-
-// clang-format on
 class Component final : public components::ComponentBase {
 public:
     /// @ingroup userver_component_names

core/src/cache/caching_component_base.yaml

@@ -14,52 +14,56 @@ properties:
         description: (*required*) interval between Update invocations
     update-jitter:
         type: string
-        description: max. amount of time by which update-interval may be adjusted
-            for requests dispersal
-        defaultDescription: update_interval / 10
+        description: |
+            Max. amount of time by which update-interval may be adjusted
+            for requests dispersal.
+
+            Default: update_interval / 10
     updates-enabled:
         type: boolean
         description: if false, cache updates are disabled (except for the first one
             if !first-update-fail-ok)
-        defaultDescription: true
+        default: true
     full-update-interval:
         type: string
         description: interval between full updates
     full-update-jitter:
         type: string
-        description: max. amount of time by which full-update-interval may be adjusted
-            for requests dispersal
-        defaultDescription: full-update-interval / 10
+        description: |
+            Max. amount of time by which full-update-interval may be adjusted
+            for requests dispersal.
+
+            Default: full-update-interval / 10
     exception-interval:
         type: string
         description: sleep interval after an unhandled exception
-        defaultDescription: update_interval
+        default: update_interval
     first-update-fail-ok:
         type: boolean
         description: whether first update failure is non-fatal
-        defaultDescription: false
+        default: false
     task-processor:
         type: string
         description: the name of the TaskProcessor for running DoWork
-        defaultDescription: main-task-processor
+        default: main-task-processor
     config-settings:
         type: boolean
         description: enables dynamic reconfiguration with CacheConfigSet
-        defaultDescription: true
+        default: true
     additional-cleanup-interval:
         type: string
         description: how often to run background RCU garbage collector
-        defaultDescription: 10 seconds
+        default: 10 seconds
     is-strong-period:
         type: boolean
         description: whether to include Update execution time in update-interval
-        defaultDescription: false
+        default: false
     has-pre-assign-check:
         type: boolean
         description: |
             enables the check before changing the value in the cache, by
             default it is the check that the new value is not empty
-        defaultDescription: false
+        default: false
     testsuite-force-periodic-update:
         type: boolean
         description: |
@@ -76,15 +80,15 @@ properties:
             fire an alert if the cache update failed specified amount of times
             in a row. If zero - alerts are disabled. Value from dynamic config
             takes priority over static
-        defaultDescription: 0
+        default: 0
         minimum: 0
     safe-data-lifetime:
         type: boolean
         description: |
             enables awaiting data destructors in the component's destructor.
             Can be set to `false` if the stored data does not refer to the component
             and its dependencies.
-        defaultDescription: true
+        default: true
     dump:
         type: object
         description: Manages cache behavior after dump load
@@ -104,7 +108,7 @@ properties:
                   - skip
                   - required
                   - best-effort
-                defaultDescription: skip
+                default: skip
             first-update-type:
                 type: string
                 description: |
@@ -113,4 +117,4 @@ properties:
                   - full
                   - incremental
                   - incremental-then-async-full
-                defaultDescription: full
+                default: full

core/src/cache/lru_cache_component_base.yaml

@@ -11,12 +11,12 @@ properties:
     lifetime:
         type: string
         description: TTL for cache entries (0 is unlimited)
-        defaultDescription: 0
+        default: 0
     background-update:
         type: boolean
         description: enables asynchronous updates for expiring values
-        defaultDescription: false
+        default: false
     config-settings:
         type: boolean
         description: enables dynamic reconfiguration with CacheConfigSet
-        defaultDescription: true
+        default: true

core/src/clients/http/component.yaml

@@ -5,7 +5,7 @@ properties:
     core-component:
         type: string
         description: name of components::HttpClientCore component to use
-        defaultDescription: http-client-core
+        default: http-client-core
     middlewares:
         type: object
         description: map of middlewares to apply. Middleware settings from components::HttpClient

core/src/clients/http/component_core.yaml

@@ -5,34 +5,36 @@ properties:
     pool-statistics-disable:
         type: boolean
         description: set to true to disable statistics for connection pool
-        defaultDescription: false
+        default: false
     thread-name-prefix:
         type: string
         description: set OS thread name to this value
-        defaultDescription: ''
+        default: ''
     threads:
         type: integer
         description: number of threads to process low level HTTP related IO system
             calls
-        defaultDescription: 8
+        default: 8
     fs-task-processor:
         type: string
-        description: task processor to run blocking HTTP related calls, like DNS resolving
-            or hosts reading
-        defaultDescription: engine::current_task::GetBlockingTaskProcessor()
+        description: |
+            Task processor to run blocking HTTP related calls, like DNS resolving
+            or hosts reading.
+
+            Default: engine::current_task::GetBlockingTaskProcessor()
     destination-metrics-auto-max-size:
         type: integer
         description: set max number of automatically created destination metrics
-        defaultDescription: 100
+        default: 100
     user-agent:
         type: string
         description: User-Agent HTTP header to show on all requests, result of utils::GetUserverIdentifier()
             if empty
-        defaultDescription: ''
+        default: ''
     testsuite-enabled:
         type: boolean
         description: enable testsuite testing support
-        defaultDescription: false
+        default: false
     testsuite-timeout:
         type: string
         description: if set, force the request timeout regardless of the value passed
@@ -47,7 +49,7 @@ properties:
     dns_resolver:
         type: string
         description: server hostname resolver type
-        defaultDescription: 'async'
+        default: 'async'
         enum:
           - getaddrinfo
           - async
@@ -58,11 +60,11 @@ properties:
             using the original timeout and the value of task-inherited deadline.
             Note: timeout is always updated from the task-inherited deadline
             when present.
-        defaultDescription: true
+        default: true
     cancellation-policy:
         type: string
         description: Cancellation policy for new requests
         enum:
           - cancel
           - ignore
-        defaultDescription: 'cancel'
+        default: 'cancel'

core/src/clients/http/middlewares/retry_budget/component.yaml

@@ -5,8 +5,8 @@ properties:
     max-tokens:
         type: number
         description: max amount of tokens in the token bucket
-        defaultDescription: 10
+        default: 10
     token-ratio:
         type: number
         description: retry count to successful responses ratio
-        defaultDescription: 0.1
+        default: 0.1

core/src/components/fs_cache.yaml

@@ -5,13 +5,15 @@ properties:
     dir:
         type: string
         description: directory to cache files from
-        defaultDescription: /var/www
+        default: /var/www
     update-period:
         type: string
         description: |
             update period (0 - fill the cache only at startup)
-        defaultDescription: 0
+        default: 0
     fs-task-processor:
         type: string
-        description: task processor to do filesystem operations
-        defaultDescription: engine::current_task::GetBlockingTaskProcessor()
+        description: |
+            Task processor to do filesystem operations
+
+            Default: engine::current_task::GetBlockingTaskProcessor()

core/src/components/impl/component_base.yaml

@@ -6,4 +6,4 @@ properties:
     load-enabled:
         type: boolean
         description: set to `false` to disable loading of the component
-        defaultDescription: true
+        default: true