UNPKG

@adpt/cloud

Version:
183 lines 5.95 kB
export interface Swagger2Contact { name?: string; url?: string; email?: string; } export interface Swagger2License { name: string; url?: string; } export interface Swagger2Info { title: string; description?: string; termsOfService?: string; contact?: Swagger2Contact; license?: Swagger2License; version: string; } export declare type Swagger2Schemes = "http" | "https" | "ws" | "wss"; export interface Swagger2Schema extends Swagger2JSONValueRanges { format?: string; title?: string; description?: string; default?: string | number | boolean | unknown[]; pattern?: string; required?: string[]; type: string; items?: Swagger2Items | Swagger2Ref; allOf?: unknown; properties?: { [name: string]: Swagger2Schema | Swagger2Ref; }; additionalProperties?: false | Swagger2Schema | Swagger2Ref; discriminator?: string; readOnly?: boolean; xml?: unknown; externalDocs?: Swagger2ExternalDocumentation; example?: unknown; } export interface Swagger2Response { description: string; schema?: Swagger2Schema | Swagger2Ref; headers?: unknown; examples?: unknown; } export interface Swagger2Operation { tags?: string[]; summary?: string; description?: string; externalDocs?: Swagger2ExternalDocumentation; operationId?: string; consumes?: string[]; produces?: string[]; parameters?: (Swagger2Parameter | Swagger2Ref)[]; responses: { [name: string]: Swagger2Response; }; schemes?: Swagger2Schemes; deprecated?: boolean; security?: unknown; } export interface Swagger2ExternalDocumentation { description?: string; url: string; } export declare type Swagger2Parameter = Swagger2ParameterOther | Swagger2ParameterBody; export interface Swagger2ParameterCommon { name: string; in: string; description?: string; required?: boolean; } export interface Swagger2ParameterBody extends Swagger2ParameterCommon { in: "body"; schema: Swagger2Schema | Swagger2Ref; } export declare type Swagger2Items = Swagger2ItemsOther | Swagger2ItemsArray; export interface Swagger2ItemsCommon extends Swagger2JSONValueRanges { collectionFormat?: "csv" | "ssv" | "tsv" | "pipes"; } export declare type Swagger2ItemsOther = Swagger2ItemsString | Swagger2ItemsNumberOrInteger | Swagger2ItemsBoolean; export interface Swagger2ItemsNonArrayCommon extends Swagger2ItemsCommon { items?: Swagger2Items | Swagger2Ref; } export interface Swagger2ItemsString extends Swagger2ItemsNonArrayCommon { type: "string"; default?: string; } export interface Swagger2ItemsNumberOrInteger { type: "number" | "integer"; default?: number; } export interface Swagger2ItemsBoolean { type: "boolean"; default?: boolean; } export interface Swagger2ItemsArray extends Swagger2ItemsCommon { type: "array"; items: Swagger2Items | Swagger2Ref; } export interface Swagger2JSONValueRanges { maximum?: number; exclusiveMaximum?: boolean; minimum?: number; exclusiveMinimum?: boolean; maxLength?: number; minLength?: number; pattern?: string; maxItems?: number; minItems?: number; uniqueItems?: boolean; enum?: unknown[]; multipleOf?: number; } export interface Swagger2ParameterOtherCommon extends Swagger2ParameterCommon, Swagger2JSONValueRanges { format?: string; allowEmptyValue?: boolean; } export declare type Swagger2ParameterOther = Swagger2ParameterStringOrFile | Swagger2ParameterNumberOrInteger | Swagger2ParameterBoolean | Swagger2ParameterArray; export interface Swagger2ParameterNonArray extends Swagger2ParameterOtherCommon { in: "query" | "header" | "path" | "formData"; items?: Swagger2Items | Swagger2Ref; } export interface Swagger2ParameterStringOrFile extends Swagger2ParameterNonArray { type: "string" | "file"; default: string; } export interface Swagger2ParameterNumberOrInteger extends Swagger2ParameterNonArray { type: "number" | "integer"; default?: number; } export interface Swagger2ParameterBoolean extends Swagger2ParameterNonArray { type: "boolean"; default?: boolean; } export declare type Swagger2ParameterCollectionFormatsNoMulti = "csv" | "ssv" | "tsv" | "pipes"; export declare type Swagger2ParameterCollectionFormats = Swagger2ParameterCollectionFormatsNoMulti | "multi"; export declare type Swagger2ParameterArray = Swagger2ParameterArrayOther | Swagger2ParameterArrayMulti; export interface Swagger2ParameterArrayCommon extends Swagger2ParameterOtherCommon { type: "array"; items: Swagger2Items | Swagger2Ref; default?: unknown[]; } export interface Swagger2ParameterArrayOther extends Swagger2ParameterArrayCommon { in: "header" | "path"; collectionFormat?: Swagger2ParameterCollectionFormatsNoMulti; } export interface Swagger2ParameterArrayMulti extends Swagger2ParameterArrayCommon { in: "query" | "formData"; collectionFormat?: Swagger2ParameterCollectionFormats; } export interface Swagger2Ref { "$ref": string; } export interface Swagger2PathItem { "$ref"?: string; get?: Swagger2Operation; put?: Swagger2Operation; post?: Swagger2Operation; delete?: Swagger2Operation; options?: Swagger2Operation; head?: Swagger2Operation; patch?: Swagger2Operation; parameters?: (Swagger2Parameter | Swagger2Ref)[]; } export interface Swagger2 { swagger: "2.0"; info: Swagger2Info; host?: string; basePath?: string; paths: { [path: string]: Swagger2PathItem; }; schemes?: Swagger2Schemes; definitions?: { [name: string]: Swagger2Schema; }; parameters?: { [name: string]: Swagger2Parameter; }; } export declare const swagger2Operations: ["get", "put", "post", "delete", "options", "head", "patch"]; export declare function isRef(x: unknown): x is Swagger2Ref; //# sourceMappingURL=swagger_types.d.ts.map