From d25821b1d72378c633af3c783fd04173c149e62f Mon Sep 17 00:00:00 2001 From: Nikita Pastukhov Date: Tue, 30 Jul 2024 23:28:35 +0300 Subject: [PATCH] docs: generate API --- docs/docs/SUMMARY.md | 104 +----------------- .../broker/response/ensure_response.md | 11 ++ 2 files changed, 12 insertions(+), 103 deletions(-) create mode 100644 docs/docs/en/api/faststream/broker/response/ensure_response.md diff --git a/docs/docs/SUMMARY.md b/docs/docs/SUMMARY.md index 92a04da868..c36a22af8f 100644 --- a/docs/docs/SUMMARY.md +++ b/docs/docs/SUMMARY.md @@ -123,14 +123,6 @@ search: - asyncapi - [get_app_schema](public_api/faststream/asyncapi/get_app_schema.md) - [get_asyncapi_html](public_api/faststream/asyncapi/get_asyncapi_html.md) - - confluent - - [KafkaBroker](public_api/faststream/confluent/KafkaBroker.md) - - [KafkaPublisher](public_api/faststream/confluent/KafkaPublisher.md) - - [KafkaResponse](public_api/faststream/confluent/KafkaResponse.md) - - [KafkaRoute](public_api/faststream/confluent/KafkaRoute.md) - - [KafkaRouter](public_api/faststream/confluent/KafkaRouter.md) - - [TestApp](public_api/faststream/confluent/TestApp.md) - - [TestKafkaBroker](public_api/faststream/confluent/TestKafkaBroker.md) - kafka - [KafkaBroker](public_api/faststream/kafka/KafkaBroker.md) - [KafkaPublisher](public_api/faststream/kafka/KafkaPublisher.md) @@ -359,6 +351,7 @@ search: - [PublisherUsecase](api/faststream/broker/publisher/usecase/PublisherUsecase.md) - response - [Response](api/faststream/broker/response/Response.md) + - [ensure_response](api/faststream/broker/response/ensure_response.md) - router - [ArgsContainer](api/faststream/broker/router/ArgsContainer.md) - [BrokerRouter](api/faststream/broker/router/BrokerRouter.md) @@ -420,101 +413,6 @@ search: - parser - [parse_cli_args](api/faststream/cli/utils/parser/parse_cli_args.md) - [remove_prefix](api/faststream/cli/utils/parser/remove_prefix.md) - - confluent - - [KafkaBroker](api/faststream/confluent/KafkaBroker.md) - - [KafkaPublisher](api/faststream/confluent/KafkaPublisher.md) - - [KafkaResponse](api/faststream/confluent/KafkaResponse.md) - - [KafkaRoute](api/faststream/confluent/KafkaRoute.md) - - [KafkaRouter](api/faststream/confluent/KafkaRouter.md) - - [TestApp](api/faststream/confluent/TestApp.md) - - [TestKafkaBroker](api/faststream/confluent/TestKafkaBroker.md) - - broker - - [KafkaBroker](api/faststream/confluent/broker/KafkaBroker.md) - - broker - - [KafkaBroker](api/faststream/confluent/broker/broker/KafkaBroker.md) - - logging - - [KafkaLoggingBroker](api/faststream/confluent/broker/logging/KafkaLoggingBroker.md) - - registrator - - [KafkaRegistrator](api/faststream/confluent/broker/registrator/KafkaRegistrator.md) - - client - - [AsyncConfluentConsumer](api/faststream/confluent/client/AsyncConfluentConsumer.md) - - [AsyncConfluentProducer](api/faststream/confluent/client/AsyncConfluentProducer.md) - - [BatchBuilder](api/faststream/confluent/client/BatchBuilder.md) - - [MsgToSend](api/faststream/confluent/client/MsgToSend.md) - - [TopicPartition](api/faststream/confluent/client/TopicPartition.md) - - [check_msg_error](api/faststream/confluent/client/check_msg_error.md) - - [create_topics](api/faststream/confluent/client/create_topics.md) - - config - - [BrokerAddressFamily](api/faststream/confluent/config/BrokerAddressFamily.md) - - [BuiltinFeatures](api/faststream/confluent/config/BuiltinFeatures.md) - - [ClientDNSLookup](api/faststream/confluent/config/ClientDNSLookup.md) - - [CompressionCodec](api/faststream/confluent/config/CompressionCodec.md) - - [CompressionType](api/faststream/confluent/config/CompressionType.md) - - [ConfluentConfig](api/faststream/confluent/config/ConfluentConfig.md) - - [Debug](api/faststream/confluent/config/Debug.md) - - [GroupProtocol](api/faststream/confluent/config/GroupProtocol.md) - - [IsolationLevel](api/faststream/confluent/config/IsolationLevel.md) - - [OffsetStoreMethod](api/faststream/confluent/config/OffsetStoreMethod.md) - - [SASLOAUTHBearerMethod](api/faststream/confluent/config/SASLOAUTHBearerMethod.md) - - [SecurityProtocol](api/faststream/confluent/config/SecurityProtocol.md) - - fastapi - - [Context](api/faststream/confluent/fastapi/Context.md) - - [KafkaRouter](api/faststream/confluent/fastapi/KafkaRouter.md) - - fastapi - - [KafkaRouter](api/faststream/confluent/fastapi/fastapi/KafkaRouter.md) - - message - - [ConsumerProtocol](api/faststream/confluent/message/ConsumerProtocol.md) - - [FakeConsumer](api/faststream/confluent/message/FakeConsumer.md) - - [KafkaMessage](api/faststream/confluent/message/KafkaMessage.md) - - opentelemetry - - [KafkaTelemetryMiddleware](api/faststream/confluent/opentelemetry/KafkaTelemetryMiddleware.md) - - middleware - - [KafkaTelemetryMiddleware](api/faststream/confluent/opentelemetry/middleware/KafkaTelemetryMiddleware.md) - - provider - - [BaseConfluentTelemetrySettingsProvider](api/faststream/confluent/opentelemetry/provider/BaseConfluentTelemetrySettingsProvider.md) - - [BatchConfluentTelemetrySettingsProvider](api/faststream/confluent/opentelemetry/provider/BatchConfluentTelemetrySettingsProvider.md) - - [ConfluentTelemetrySettingsProvider](api/faststream/confluent/opentelemetry/provider/ConfluentTelemetrySettingsProvider.md) - - [telemetry_attributes_provider_factory](api/faststream/confluent/opentelemetry/provider/telemetry_attributes_provider_factory.md) - - parser - - [AsyncConfluentParser](api/faststream/confluent/parser/AsyncConfluentParser.md) - - publisher - - asyncapi - - [AsyncAPIBatchPublisher](api/faststream/confluent/publisher/asyncapi/AsyncAPIBatchPublisher.md) - - [AsyncAPIDefaultPublisher](api/faststream/confluent/publisher/asyncapi/AsyncAPIDefaultPublisher.md) - - [AsyncAPIPublisher](api/faststream/confluent/publisher/asyncapi/AsyncAPIPublisher.md) - - producer - - [AsyncConfluentFastProducer](api/faststream/confluent/publisher/producer/AsyncConfluentFastProducer.md) - - usecase - - [BatchPublisher](api/faststream/confluent/publisher/usecase/BatchPublisher.md) - - [DefaultPublisher](api/faststream/confluent/publisher/usecase/DefaultPublisher.md) - - [LogicPublisher](api/faststream/confluent/publisher/usecase/LogicPublisher.md) - - response - - [KafkaResponse](api/faststream/confluent/response/KafkaResponse.md) - - router - - [KafkaPublisher](api/faststream/confluent/router/KafkaPublisher.md) - - [KafkaRoute](api/faststream/confluent/router/KafkaRoute.md) - - [KafkaRouter](api/faststream/confluent/router/KafkaRouter.md) - - schemas - - params - - [ConsumerConnectionParams](api/faststream/confluent/schemas/params/ConsumerConnectionParams.md) - - security - - [parse_security](api/faststream/confluent/security/parse_security.md) - - subscriber - - asyncapi - - [AsyncAPIBatchSubscriber](api/faststream/confluent/subscriber/asyncapi/AsyncAPIBatchSubscriber.md) - - [AsyncAPIDefaultSubscriber](api/faststream/confluent/subscriber/asyncapi/AsyncAPIDefaultSubscriber.md) - - [AsyncAPISubscriber](api/faststream/confluent/subscriber/asyncapi/AsyncAPISubscriber.md) - - factory - - [create_subscriber](api/faststream/confluent/subscriber/factory/create_subscriber.md) - - usecase - - [BatchSubscriber](api/faststream/confluent/subscriber/usecase/BatchSubscriber.md) - - [DefaultSubscriber](api/faststream/confluent/subscriber/usecase/DefaultSubscriber.md) - - [LogicSubscriber](api/faststream/confluent/subscriber/usecase/LogicSubscriber.md) - - testing - - [FakeProducer](api/faststream/confluent/testing/FakeProducer.md) - - [MockConfluentMessage](api/faststream/confluent/testing/MockConfluentMessage.md) - - [TestKafkaBroker](api/faststream/confluent/testing/TestKafkaBroker.md) - - [build_message](api/faststream/confluent/testing/build_message.md) - constants - [ContentTypes](api/faststream/constants/ContentTypes.md) - exceptions diff --git a/docs/docs/en/api/faststream/broker/response/ensure_response.md b/docs/docs/en/api/faststream/broker/response/ensure_response.md new file mode 100644 index 0000000000..b4a98bd4a4 --- /dev/null +++ b/docs/docs/en/api/faststream/broker/response/ensure_response.md @@ -0,0 +1,11 @@ +--- +# 0.5 - API +# 2 - Release +# 3 - Contributing +# 5 - Template Page +# 10 - Default +search: + boost: 0.5 +--- + +::: faststream.broker.response.ensure_response