docs: show events emitted in an API route in the API reference (#12392)
* docs: show events emitted in an API route in the API reference * fix build error * support version tag * add missing property
This commit is contained in:
1 parent
0dd4572964
commit
262064fe96
8 files changed
+166
No files matched your search
@@ -22,6 +22,7 @@ export type Operation = OpenAPIV3.OperationObject<{
|
||||
"x-featureFlag"?: string
|
||||
"x-workflow"?: string
|
||||
"x-sidebar-summary"?: string
|
||||
"x-events"?: OasEvents[]
|
||||
}>
|
||||
|
||||
export type RequestObject = OpenAPIV3.RequestBodyObject & {
|
||||
@@ -134,3 +135,12 @@ export type TagObject = OpenAPIV3.TagObject & {
|
||||
export type ParsedPathItemObject = OpenAPIV3.PathItemObject<Operation> & {
|
||||
operationPath?: string
|
||||
}
|
||||
|
||||
export type OasEvents = {
|
||||
name: string
|
||||
payload: string
|
||||
description?: string
|
||||
deprecated?: boolean
|
||||
deprecated_message?: string
|
||||
version?: string
|
||||
}
|
||||
Reference in new issue
Block a user