#include <userver/yaml_config/schema.hpp>

Detailed Description

JSON Schema-like type definition.

See also: https://json-schema.org/specification; Static configs validation

Examples: components/component_sample_test.hpp, libraries/easy/samples/4_custom_dependency/main.cpp, libraries/easy/samples/5_pg_service_template/src/main.cpp, samples/grpc_middleware_service/src/middlewares/server/meta_filter.cpp, samples/grpc_middleware_service/src/middlewares/server/meta_filter.hpp, samples/grpc_service/src/greeter_service.cpp, samples/grpc_service/src/greeter_service.hpp, samples/http_caching/main.cpp, samples/s3api/src/s3api_client.cpp, samples/s3api/src/s3api_client.hpp, samples/tcp_service/main.cpp, samples/ydb_service/components/federated_topic_reader.cpp, samples/ydb_service/components/federated_topic_reader.hpp, samples/ydb_service/components/topic_reader.cpp, and samples/ydb_service/components/topic_reader.hpp.

Definition at line 70 of file schema.hpp.

Inheritance diagram for yaml_config::Schema:

Public Member Functions
void	UpdateDescription (std::string new_description)

bool	operator== (const Schema &) const noexcept

bool	operator== (const PathSupplementary &) const noexcept

Static Public Member Functions
static Schema	EmptyObject ()

Public Attributes
FieldType	type {}

std::string	description

std::optional< std::string >	default_description

std::optional< std::variant< bool, SchemaPtr > >	additional_properties

std::optional< std::unordered_map< std::string, SchemaPtr > >	properties

std::optional< SchemaPtr >	items

std::optional< std::unordered_set< std::string > >	enum_values

std::optional< double >	minimum

std::optional< double >	maximum

std::optional< std::size_t >	min_items

std::optional< std::size_t >	max_items

std::optional< std::unordered_set< std::string > >	required

std::string	path

Member Data Documentation

◆ additional_properties

std::optional<std::variant<bool, SchemaPtr> > yaml_config::Schema::additional_properties

Definition at line 80 of file schema.hpp.

◆ default_description

std::optional<std::string> yaml_config::Schema::default_description

Definition at line 79 of file schema.hpp.

◆ description

std::string yaml_config::Schema::description

Definition at line 78 of file schema.hpp.

◆ enum_values

std::optional<std::unordered_set<std::string> > yaml_config::Schema::enum_values

Definition at line 83 of file schema.hpp.

◆ items

std::optional<SchemaPtr> yaml_config::Schema::items

Definition at line 82 of file schema.hpp.

◆ max_items

std::optional<std::size_t> yaml_config::Schema::max_items

Definition at line 87 of file schema.hpp.

◆ maximum

std::optional<double> yaml_config::Schema::maximum

Definition at line 85 of file schema.hpp.

◆ min_items

std::optional<std::size_t> yaml_config::Schema::min_items

Definition at line 86 of file schema.hpp.

◆ minimum

std::optional<double> yaml_config::Schema::minimum

Definition at line 84 of file schema.hpp.

◆ path

std::string yaml_config::PathSupplementary::path

inherited

Definition at line 61 of file schema.hpp.

◆ properties

std::optional<std::unordered_map<std::string, SchemaPtr> > yaml_config::Schema::properties

Definition at line 81 of file schema.hpp.

◆ required

std::optional<std::unordered_set<std::string> > yaml_config::Schema::required

Definition at line 88 of file schema.hpp.

◆ type

FieldType yaml_config::Schema::type {}

Definition at line 77 of file schema.hpp.

The documentation for this struct was generated from the following file:

userver/yaml_config/schema.hpp