1
0
mirror of synced 2025-12-22 19:34:15 -05:00
Files
docs/components/rest/types.ts
2022-02-28 18:30:54 +00:00

72 lines
1.2 KiB
TypeScript

export interface Operation {
verb: string
summary: string
slug: string
descriptionHTML: string
notes: Array<string>
requestPath: string
responses: Array<CodeResponse>
hasRequiredPreviews: boolean
parameters: Array<Parameter>
bodyParameters: Array<BodyParameter>
'x-github': xGitHub
'x-codeSamples': Array<xCodeSample>
}
export interface Parameter {
in: string
name: string
descriptionHTML: string
required: boolean
schema: {
type: string
default?: string
}
}
export interface xGitHub {
category: string
enabledForGitHubApps: boolean
previews: Array<Preview> | []
}
export interface CodeResponse {
description: string
httpStatusCode: string
httpStatusMessage: string
payload: string
}
export interface xCodeSample {
lang: string
sourceHTML: string
}
export interface Preview {
html: string
required: boolean
name: string
}
export interface BodyParameter {
in: string
name: string
childParamsGroups?: Array<ChildParamsGroup>
default?: string
description: string
type: string
}
export interface ChildParamsGroup {
id: string
params: Array<ChildParameter>
parentName: string
parentType: string
}
export interface ChildParameter {
name: string
description: string
type: string
}