Skip to content

Commit

Permalink
docs: add Response References
Browse files Browse the repository at this point in the history
  • Loading branch information
Lancetnik committed May 28, 2024
1 parent 0047638 commit 9425c63
Show file tree
Hide file tree
Showing 11 changed files with 130 additions and 86 deletions.
106 changes: 20 additions & 86 deletions docs/docs/SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -116,21 +116,16 @@ search:
- [FastStream](public_api/faststream/FastStream.md)
- [Header](public_api/faststream/Header.md)
- [Path](public_api/faststream/Path.md)
- [Response](public_api/faststream/Response.md)
- [TestApp](public_api/faststream/TestApp.md)
- [apply_types](public_api/faststream/apply_types.md)
- 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)
- [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)
- [KafkaResponse](public_api/faststream/kafka/KafkaResponse.md)
- [KafkaRoute](public_api/faststream/kafka/KafkaRoute.md)
- [KafkaRouter](public_api/faststream/kafka/KafkaRouter.md)
- [TestApp](public_api/faststream/kafka/TestApp.md)
Expand All @@ -146,6 +141,7 @@ search:
- [KvWatch](public_api/faststream/nats/KvWatch.md)
- [NatsBroker](public_api/faststream/nats/NatsBroker.md)
- [NatsPublisher](public_api/faststream/nats/NatsPublisher.md)
- [NatsResponse](public_api/faststream/nats/NatsResponse.md)
- [NatsRoute](public_api/faststream/nats/NatsRoute.md)
- [NatsRouter](public_api/faststream/nats/NatsRouter.md)
- [ObjWatch](public_api/faststream/nats/ObjWatch.md)
Expand All @@ -165,6 +161,7 @@ search:
- [RabbitExchange](public_api/faststream/rabbit/RabbitExchange.md)
- [RabbitPublisher](public_api/faststream/rabbit/RabbitPublisher.md)
- [RabbitQueue](public_api/faststream/rabbit/RabbitQueue.md)
- [RabbitResponse](public_api/faststream/rabbit/RabbitResponse.md)
- [RabbitRoute](public_api/faststream/rabbit/RabbitRoute.md)
- [RabbitRouter](public_api/faststream/rabbit/RabbitRouter.md)
- [ReplyConfig](public_api/faststream/rabbit/ReplyConfig.md)
Expand All @@ -175,6 +172,7 @@ search:
- [PubSub](public_api/faststream/redis/PubSub.md)
- [RedisBroker](public_api/faststream/redis/RedisBroker.md)
- [RedisPublisher](public_api/faststream/redis/RedisPublisher.md)
- [RedisResponse](public_api/faststream/redis/RedisResponse.md)
- [RedisRoute](public_api/faststream/redis/RedisRoute.md)
- [RedisRouter](public_api/faststream/redis/RedisRouter.md)
- [StreamSub](public_api/faststream/redis/StreamSub.md)
Expand All @@ -188,6 +186,7 @@ search:
- [FastStream](api/faststream/FastStream.md)
- [Header](api/faststream/Header.md)
- [Path](api/faststream/Path.md)
- [Response](api/faststream/Response.md)
- [TestApp](api/faststream/TestApp.md)
- [apply_types](api/faststream/apply_types.md)
- app
Expand Down Expand Up @@ -349,6 +348,8 @@ search:
- [PublisherProto](api/faststream/broker/publisher/proto/PublisherProto.md)
- usecase
- [PublisherUsecase](api/faststream/broker/publisher/usecase/PublisherUsecase.md)
- response
- [Response](api/faststream/broker/response/Response.md)
- router
- [ArgsContainer](api/faststream/broker/router/ArgsContainer.md)
- [BrokerRouter](api/faststream/broker/router/BrokerRouter.md)
Expand Down Expand Up @@ -410,85 +411,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)
- [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)
- 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)
- 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
Expand All @@ -506,6 +428,7 @@ search:
- kafka
- [KafkaBroker](api/faststream/kafka/KafkaBroker.md)
- [KafkaPublisher](api/faststream/kafka/KafkaPublisher.md)
- [KafkaResponse](api/faststream/kafka/KafkaResponse.md)
- [KafkaRoute](api/faststream/kafka/KafkaRoute.md)
- [KafkaRouter](api/faststream/kafka/KafkaRouter.md)
- [TestApp](api/faststream/kafka/TestApp.md)
Expand Down Expand Up @@ -550,6 +473,8 @@ search:
- [BatchPublisher](api/faststream/kafka/publisher/usecase/BatchPublisher.md)
- [DefaultPublisher](api/faststream/kafka/publisher/usecase/DefaultPublisher.md)
- [LogicPublisher](api/faststream/kafka/publisher/usecase/LogicPublisher.md)
- response
- [KafkaResponse](api/faststream/kafka/response/KafkaResponse.md)
- router
- [KafkaPublisher](api/faststream/kafka/router/KafkaPublisher.md)
- [KafkaRoute](api/faststream/kafka/router/KafkaRoute.md)
Expand Down Expand Up @@ -592,6 +517,7 @@ search:
- [KvWatch](api/faststream/nats/KvWatch.md)
- [NatsBroker](api/faststream/nats/NatsBroker.md)
- [NatsPublisher](api/faststream/nats/NatsPublisher.md)
- [NatsResponse](api/faststream/nats/NatsResponse.md)
- [NatsRoute](api/faststream/nats/NatsRoute.md)
- [NatsRouter](api/faststream/nats/NatsRouter.md)
- [ObjWatch](api/faststream/nats/ObjWatch.md)
Expand Down Expand Up @@ -657,6 +583,8 @@ search:
- [NatsJSFastProducer](api/faststream/nats/publisher/producer/NatsJSFastProducer.md)
- usecase
- [LogicPublisher](api/faststream/nats/publisher/usecase/LogicPublisher.md)
- response
- [NatsResponse](api/faststream/nats/response/NatsResponse.md)
- router
- [NatsPublisher](api/faststream/nats/router/NatsPublisher.md)
- [NatsRoute](api/faststream/nats/router/NatsRoute.md)
Expand Down Expand Up @@ -728,6 +656,7 @@ search:
- [RabbitExchange](api/faststream/rabbit/RabbitExchange.md)
- [RabbitPublisher](api/faststream/rabbit/RabbitPublisher.md)
- [RabbitQueue](api/faststream/rabbit/RabbitQueue.md)
- [RabbitResponse](api/faststream/rabbit/RabbitResponse.md)
- [RabbitRoute](api/faststream/rabbit/RabbitRoute.md)
- [RabbitRouter](api/faststream/rabbit/RabbitRouter.md)
- [ReplyConfig](api/faststream/rabbit/ReplyConfig.md)
Expand Down Expand Up @@ -764,6 +693,8 @@ search:
- usecase
- [LogicPublisher](api/faststream/rabbit/publisher/usecase/LogicPublisher.md)
- [PublishKwargs](api/faststream/rabbit/publisher/usecase/PublishKwargs.md)
- response
- [RabbitResponse](api/faststream/rabbit/response/RabbitResponse.md)
- router
- [RabbitPublisher](api/faststream/rabbit/router/RabbitPublisher.md)
- [RabbitRoute](api/faststream/rabbit/router/RabbitRoute.md)
Expand Down Expand Up @@ -808,6 +739,7 @@ search:
- [PubSub](api/faststream/redis/PubSub.md)
- [RedisBroker](api/faststream/redis/RedisBroker.md)
- [RedisPublisher](api/faststream/redis/RedisPublisher.md)
- [RedisResponse](api/faststream/redis/RedisResponse.md)
- [RedisRoute](api/faststream/redis/RedisRoute.md)
- [RedisRouter](api/faststream/redis/RedisRouter.md)
- [StreamSub](api/faststream/redis/StreamSub.md)
Expand Down Expand Up @@ -869,6 +801,8 @@ search:
- [ListPublisher](api/faststream/redis/publisher/usecase/ListPublisher.md)
- [LogicPublisher](api/faststream/redis/publisher/usecase/LogicPublisher.md)
- [StreamPublisher](api/faststream/redis/publisher/usecase/StreamPublisher.md)
- response
- [RedisResponse](api/faststream/redis/response/RedisResponse.md)
- router
- [RedisPublisher](api/faststream/redis/router/RedisPublisher.md)
- [RedisRoute](api/faststream/redis/router/RedisRoute.md)
Expand Down
11 changes: 11 additions & 0 deletions docs/docs/en/api/faststream/Response.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
# 0.5 - API
# 2 - Release
# 3 - Contributing
# 5 - Template Page
# 10 - Default
search:
boost: 0.5
---

::: faststream.Response
11 changes: 11 additions & 0 deletions docs/docs/en/api/faststream/broker/response/Response.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
# 0.5 - API
# 2 - Release
# 3 - Contributing
# 5 - Template Page
# 10 - Default
search:
boost: 0.5
---

::: faststream.broker.response.Response
11 changes: 11 additions & 0 deletions docs/docs/en/api/faststream/kafka/KafkaResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
# 0.5 - API
# 2 - Release
# 3 - Contributing
# 5 - Template Page
# 10 - Default
search:
boost: 0.5
---

::: faststream.kafka.KafkaResponse
11 changes: 11 additions & 0 deletions docs/docs/en/api/faststream/kafka/response/KafkaResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
# 0.5 - API
# 2 - Release
# 3 - Contributing
# 5 - Template Page
# 10 - Default
search:
boost: 0.5
---

::: faststream.kafka.response.KafkaResponse
11 changes: 11 additions & 0 deletions docs/docs/en/api/faststream/nats/NatsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
# 0.5 - API
# 2 - Release
# 3 - Contributing
# 5 - Template Page
# 10 - Default
search:
boost: 0.5
---

::: faststream.nats.NatsResponse
11 changes: 11 additions & 0 deletions docs/docs/en/api/faststream/nats/response/NatsResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
# 0.5 - API
# 2 - Release
# 3 - Contributing
# 5 - Template Page
# 10 - Default
search:
boost: 0.5
---

::: faststream.nats.response.NatsResponse
11 changes: 11 additions & 0 deletions docs/docs/en/api/faststream/rabbit/RabbitResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
# 0.5 - API
# 2 - Release
# 3 - Contributing
# 5 - Template Page
# 10 - Default
search:
boost: 0.5
---

::: faststream.rabbit.RabbitResponse
11 changes: 11 additions & 0 deletions docs/docs/en/api/faststream/rabbit/response/RabbitResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
# 0.5 - API
# 2 - Release
# 3 - Contributing
# 5 - Template Page
# 10 - Default
search:
boost: 0.5
---

::: faststream.rabbit.response.RabbitResponse
11 changes: 11 additions & 0 deletions docs/docs/en/api/faststream/redis/RedisResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
# 0.5 - API
# 2 - Release
# 3 - Contributing
# 5 - Template Page
# 10 - Default
search:
boost: 0.5
---

::: faststream.redis.RedisResponse
11 changes: 11 additions & 0 deletions docs/docs/en/api/faststream/redis/response/RedisResponse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
---
# 0.5 - API
# 2 - Release
# 3 - Contributing
# 5 - Template Page
# 10 - Default
search:
boost: 0.5
---

::: faststream.redis.response.RedisResponse

0 comments on commit 9425c63

Please sign in to comment.