-
Notifications
You must be signed in to change notification settings - Fork 1
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Faststream docs #403
Draft
Kilo59
wants to merge
9
commits into
fastapi-poc
Choose a base branch
from
faststream-docs
base: fastapi-poc
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+1,011
−111
Draft
Faststream docs #403
Changes from 8 commits
Commits
Show all changes
9 commits
Select commit
Hold shift + click to select a range
ae8523b
gen-asyncapi docs invoke placeholder task
Kilo59 c5cf21e
gen-asyncapi docs
Kilo59 eced3dd
temporary global handler
Kilo59 9fbf35d
use framework event parsing
Kilo59 1fe0901
ban pydantic v1
Kilo59 8ff4f45
pydantic-settings
Kilo59 c5afcf9
move to pydantic v2 models
Kilo59 2a552f7
docs working!
Kilo59 2eaad24
fast-depends version bump
Kilo59 File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
Large diffs are not rendered by default.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,355 @@ | ||
asyncapi: 2.6.0 | ||
defaultContentType: application/json | ||
info: | ||
title: FastStream | ||
version: 0.1.0 | ||
description: "" | ||
servers: | ||
development: | ||
url: amqps://org-agent-a7ba9504-a02f-40c8-8c46-145b4ff5765b:d%23,0foO~&,7+nh%3EVgH%5DIY.m9%3Ayi%3FX0Ydn%7DR%40d8I(GK%60%3FzfFcen,-%7D33o%2FuE*~SD'@mq.greatexpectations.io:5671/ | ||
protocol: amqps | ||
protocolVersion: 0.9.1 | ||
channels: | ||
q-a7ba9504-a02f-40c8-8c46-145b4ff5765b:_:HandleEvent: | ||
servers: | ||
- development | ||
bindings: | ||
amqp: | ||
is: routingKey | ||
bindingVersion: 0.2.0 | ||
queue: | ||
name: q-a7ba9504-a02f-40c8-8c46-145b4ff5765b | ||
durable: true | ||
exclusive: false | ||
autoDelete: false | ||
vhost: / | ||
exchange: | ||
type: default | ||
vhost: / | ||
subscribe: | ||
bindings: | ||
amqp: | ||
cc: q-a7ba9504-a02f-40c8-8c46-145b4ff5765b | ||
ack: true | ||
bindingVersion: 0.2.0 | ||
message: | ||
$ref: "#/components/messages/q-a7ba9504-a02f-40c8-8c46-145b4ff5765b:_:HandleEvent:Message" | ||
components: | ||
messages: | ||
q-a7ba9504-a02f-40c8-8c46-145b4ff5765b:_:HandleEvent:Message: | ||
title: q-a7ba9504-a02f-40c8-8c46-145b4ff5765b:_:HandleEvent:Message | ||
correlationId: | ||
location: $message.header#/correlation_id | ||
payload: | ||
$ref: "#/components/schemas/EventMessage" | ||
schemas: | ||
DraftDatasourceConfigEvent: | ||
properties: | ||
type: | ||
const: test_datasource_config | ||
default: test_datasource_config | ||
enum: | ||
- test_datasource_config | ||
title: Type | ||
type: string | ||
organization_id: | ||
anyOf: | ||
- format: uuid | ||
type: string | ||
- type: "null" | ||
default: null | ||
title: Organization Id | ||
config_id: | ||
format: uuid | ||
title: Config Id | ||
type: string | ||
required: | ||
- config_id | ||
title: DraftDatasourceConfigEvent | ||
type: object | ||
ListTableNamesEvent: | ||
properties: | ||
type: | ||
const: list_table_names_request.received | ||
default: list_table_names_request.received | ||
enum: | ||
- list_table_names_request.received | ||
title: Type | ||
type: string | ||
organization_id: | ||
anyOf: | ||
- format: uuid | ||
type: string | ||
- type: "null" | ||
default: null | ||
title: Organization Id | ||
datasource_name: | ||
title: Datasource Name | ||
type: string | ||
required: | ||
- datasource_name | ||
title: ListTableNamesEvent | ||
type: object | ||
MetricTypes: | ||
description: | ||
"Represents Metric types in OSS that are used for ColumnDescriptiveMetrics | ||
and MetricRepository. | ||
|
||
|
||
More Metric types will be added in the future." | ||
enum: | ||
- table.columns | ||
- table.row_count | ||
- table.column_types | ||
- column.min | ||
- column.max | ||
- column.median | ||
- column.mean | ||
- column_values.null.count | ||
title: MetricTypes | ||
type: string | ||
RunCheckpointEvent: | ||
properties: | ||
type: | ||
const: run_checkpoint_request | ||
default: run_checkpoint_request | ||
enum: | ||
- run_checkpoint_request | ||
title: Type | ||
type: string | ||
organization_id: | ||
anyOf: | ||
- format: uuid | ||
type: string | ||
- type: "null" | ||
default: null | ||
title: Organization Id | ||
datasource_names_to_asset_names: | ||
additionalProperties: | ||
items: | ||
type: string | ||
type: array | ||
uniqueItems: true | ||
title: Datasource Names To Asset Names | ||
type: object | ||
checkpoint_id: | ||
format: uuid | ||
title: Checkpoint Id | ||
type: string | ||
splitter_options: | ||
anyOf: | ||
- type: object | ||
- type: "null" | ||
default: null | ||
title: Splitter Options | ||
required: | ||
- datasource_names_to_asset_names | ||
- checkpoint_id | ||
title: RunCheckpointEvent | ||
type: object | ||
RunColumnDescriptiveMetricsEvent: | ||
properties: | ||
type: | ||
const: column_descriptive_metrics_request.received | ||
default: column_descriptive_metrics_request.received | ||
enum: | ||
- column_descriptive_metrics_request.received | ||
title: Type | ||
type: string | ||
organization_id: | ||
anyOf: | ||
- format: uuid | ||
type: string | ||
- type: "null" | ||
default: null | ||
title: Organization Id | ||
datasource_name: | ||
title: Datasource Name | ||
type: string | ||
data_asset_name: | ||
title: Data Asset Name | ||
type: string | ||
required: | ||
- datasource_name | ||
- data_asset_name | ||
title: RunColumnDescriptiveMetricsEvent | ||
type: object | ||
RunMetricsListEvent: | ||
properties: | ||
type: | ||
const: metrics_list_request.received | ||
default: metrics_list_request.received | ||
enum: | ||
- metrics_list_request.received | ||
title: Type | ||
type: string | ||
organization_id: | ||
anyOf: | ||
- format: uuid | ||
type: string | ||
- type: "null" | ||
default: null | ||
title: Organization Id | ||
datasource_name: | ||
title: Datasource Name | ||
type: string | ||
data_asset_name: | ||
title: Data Asset Name | ||
type: string | ||
metric_names: | ||
items: | ||
$ref: "#/components/schemas/MetricTypes" | ||
title: Metric Names | ||
type: array | ||
required: | ||
- datasource_name | ||
- data_asset_name | ||
- metric_names | ||
title: RunMetricsListEvent | ||
type: object | ||
RunMissingnessDataAssistantEvent: | ||
properties: | ||
type: | ||
const: missingness_data_assistant_request.received | ||
default: missingness_data_assistant_request.received | ||
enum: | ||
- missingness_data_assistant_request.received | ||
title: Type | ||
type: string | ||
organization_id: | ||
anyOf: | ||
- format: uuid | ||
type: string | ||
- type: "null" | ||
default: null | ||
title: Organization Id | ||
datasource_name: | ||
title: Datasource Name | ||
type: string | ||
data_asset_name: | ||
title: Data Asset Name | ||
type: string | ||
expectation_suite_name: | ||
anyOf: | ||
- type: string | ||
- type: "null" | ||
default: null | ||
title: Expectation Suite Name | ||
required: | ||
- datasource_name | ||
- data_asset_name | ||
title: RunMissingnessDataAssistantEvent | ||
type: object | ||
RunOnboardingDataAssistantEvent: | ||
properties: | ||
type: | ||
const: onboarding_data_assistant_request.received | ||
default: onboarding_data_assistant_request.received | ||
enum: | ||
- onboarding_data_assistant_request.received | ||
title: Type | ||
type: string | ||
organization_id: | ||
anyOf: | ||
- format: uuid | ||
type: string | ||
- type: "null" | ||
default: null | ||
title: Organization Id | ||
datasource_name: | ||
title: Datasource Name | ||
type: string | ||
data_asset_name: | ||
title: Data Asset Name | ||
type: string | ||
expectation_suite_name: | ||
anyOf: | ||
- type: string | ||
- type: "null" | ||
default: null | ||
title: Expectation Suite Name | ||
required: | ||
- datasource_name | ||
- data_asset_name | ||
title: RunOnboardingDataAssistantEvent | ||
type: object | ||
RunScheduledCheckpointEvent: | ||
properties: | ||
type: | ||
const: run_scheduled_checkpoint.received | ||
default: run_scheduled_checkpoint.received | ||
enum: | ||
- run_scheduled_checkpoint.received | ||
title: Type | ||
type: string | ||
organization_id: | ||
anyOf: | ||
- format: uuid | ||
type: string | ||
- type: "null" | ||
default: null | ||
title: Organization Id | ||
schedule_id: | ||
format: uuid | ||
title: Schedule Id | ||
type: string | ||
datasource_names_to_asset_names: | ||
additionalProperties: | ||
items: | ||
type: string | ||
type: array | ||
uniqueItems: true | ||
title: Datasource Names To Asset Names | ||
type: object | ||
checkpoint_id: | ||
format: uuid | ||
title: Checkpoint Id | ||
type: string | ||
splitter_options: | ||
anyOf: | ||
- type: object | ||
- type: "null" | ||
default: null | ||
title: Splitter Options | ||
required: | ||
- schedule_id | ||
- datasource_names_to_asset_names | ||
- checkpoint_id | ||
title: RunScheduledCheckpointEvent | ||
type: object | ||
UnknownEvent: | ||
additionalProperties: false | ||
properties: | ||
type: | ||
const: unknown_event | ||
default: unknown_event | ||
enum: | ||
- unknown_event | ||
title: Type | ||
type: string | ||
title: UnknownEvent | ||
type: object | ||
EventMessage: | ||
additionalProperties: false | ||
properties: | ||
event: | ||
discriminator: type | ||
oneOf: | ||
- $ref: "#/components/schemas/RunOnboardingDataAssistantEvent" | ||
- $ref: "#/components/schemas/RunMissingnessDataAssistantEvent" | ||
- $ref: "#/components/schemas/RunCheckpointEvent" | ||
- $ref: "#/components/schemas/RunScheduledCheckpointEvent" | ||
- $ref: "#/components/schemas/RunColumnDescriptiveMetricsEvent" | ||
- $ref: "#/components/schemas/RunMetricsListEvent" | ||
- $ref: "#/components/schemas/DraftDatasourceConfigEvent" | ||
- $ref: "#/components/schemas/ListTableNamesEvent" | ||
- $ref: "#/components/schemas/UnknownEvent" | ||
title: Event | ||
correlation_id: | ||
title: Correlation Id | ||
type: string | ||
required: | ||
- event | ||
- correlation_id | ||
title: EventMessage | ||
type: object |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To see what these docs would look like live, go to the asyncapi studio and paste them into the editor.
https://studio.asyncapi.com/