@azure-tools/openapi/dist/v3/oai3.d.ts

OpenAPI common code for Azure Tools.

import { Extensions, Refable } from "../common";
import { EnumStr } from "./common";
export type Dictionary<T> = {
    [key: string]: T;
};
/** Properties, Parameters, Operations and Schemas require additional support */
export interface Implementation<T> {
}
export interface Details {
}
/**
 * Property References may have additional data that's not in the target reference
 */
export interface PropertyDetails extends Details, Extensions {
    description?: string;
    readOnly?: boolean;
    nullable?: boolean;
}
/** Parameter References may have additional data that's not in the target reference */
export interface ParameterDetails extends Details, Extensions {
    description?: string;
}
export interface SchemaDetails extends Details {
}
export interface HttpOperationDetails extends Details {
}
/**
 * @description The location of the parameter.
 *
 * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#user-content-parameterIn
 */
export declare enum ParameterLocation {
    Query = "query",
    Header = "header",
    Cookie = "cookie",
    Path = "path"
}
export declare function hasContent<T extends Partial<HasContent>>(parameter: T): parameter is HasContent & T;
export declare function hasSchema<T extends Partial<HasSchema>>(parameter: T): parameter is HasSchema & T;
export declare function hasExample<T extends HasExample>(parameter: T): parameter is HasExample & T;
export declare function hasExamples<T extends HasExamples>(parameter: T): parameter is HasExamples & T;
export declare function isCookieParameter(parameter: Parameter): parameter is InCookie & Parameter;
export declare function isHeaderParameter(parameter: Parameter): parameter is InHeader & Parameter;
export declare function isPathParameter(parameter: Parameter): parameter is InPath & Parameter;
export declare function isQueryParameter(parameter: Parameter): parameter is InQuery & Parameter;
/**
 * Properties have additional data when referencing them
 */
export type PropertyReference<T extends {}> = PropertyDetails & Refable<T>;
/**
 * Parameter references could have additional data to override the shared parameter value.
 */
export type ParameterReference<T extends {}> = ParameterDetails & Refable<T>;
/**
 * @description common ways of serializing simple parameters
 * @see https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.1.md#style-values
 */
export declare enum EncodingStyle {
    Matrix = "matrix",
    Label = "label",
    Simple = "simple",
    Form = "form",
    SpaceDelimited = "spaceDelimited",
    PipeDelimited = "pipeDelimited",
    TabDelimited = "tabDelimited",
    DeepObject = "deepObject"
}
export declare enum JsonType {
    Array = "array",
    Boolean = "boolean",
    Integer = "integer",
    Number = "number",
    Object = "object",
    String = "string"
}
export declare enum Scheme {
    Bearer = "bearer"
}
export declare enum SecurityType {
    ApiKey = "apiKey",
    Http = "http",
    OAuth2 = "oauth2",
    OpenIDConnect = "openIdConnect"
}
export interface Callback extends Dictionary<PathItem> {
}
export interface SecurityRequirement extends Dictionary<string[]> {
}
export type HTTPSecurityScheme = NonBearerHTTPSecurityScheme | BearerHTTPSecurityScheme;
export type SecurityScheme = APIKeySecurityScheme | HTTPSecurityScheme | OAuth2SecurityScheme | OpenIdConnectSecurityScheme;
export type QueryEncodingStyle = EncodingStyle.Form | EncodingStyle.SpaceDelimited | EncodingStyle.PipeDelimited | EncodingStyle.DeepObject;
export type PathEncodingStyle = EncodingStyle.Matrix | EncodingStyle.Label | EncodingStyle.Simple;
export interface OpenAPI3Document extends Extensions {
    paths: Dictionary<PathItem>;
    openapi: string;
    info: Info;
    externalDocs?: ExternalDocumentation;
    servers?: Array<Server>;
    security?: Array<SecurityRequirement>;
    tags?: Array<Tag>;
    components?: Components;
}
export interface Components extends Extensions {
    schemas?: Dictionary<Schema>;
    responses?: Dictionary<Response>;
    parameters?: Dictionary<Parameter>;
    examples?: Dictionary<Example>;
    requestBodies?: Dictionary<RequestBody>;
    headers?: Dictionary<Header>;
    securitySchemes?: Dictionary<SecurityScheme>;
    links?: Dictionary<Link>;
    callbacks?: Dictionary<Callback>;
}
export interface APIKeySecurityScheme extends Extensions {
    type: SecurityType.ApiKey;
    name: string;
    in: EnumStr<ParameterLocation>;
    description?: string;
}
export interface AuthorizationCodeOAuthFlow extends Extensions {
    authorizationUrl: string;
    tokenUrl: string;
    refreshUrl?: string;
    scopes?: Dictionary<string>;
}
export interface BearerHTTPSecurityScheme extends Extensions {
    scheme: Scheme.Bearer;
    bearerFormat?: string;
    type: SecurityType.Http;
    description?: string;
}
export interface ClientCredentialsFlow extends Extensions {
    tokenUrl: string;
    refreshUrl?: string;
    scopes?: Dictionary<string>;
}
export interface Contact extends Extensions {
    name?: string;
    url?: string;
    email?: string;
}
export interface Discriminator extends Extensions {
    propertyName: string;
    mapping?: Dictionary<string>;
}
export interface Encoding extends Extensions {
    contentType?: string;
    headers?: Dictionary<Refable<Header>>;
    style?: QueryEncodingStyle;
    explode?: boolean;
    allowReserved?: boolean;
}
export interface Example extends Extensions {
    summary?: string;
    description?: string;
    value?: any;
    externalValue?: string;
}
export interface ExternalDocumentation extends Extensions {
    description?: string;
    url: string;
}
export interface Header extends Deprecatable, Extensions, Partial<HasContent>, Partial<HasSchema>, Partial<HasExample>, Partial<HasExamples> {
    description?: string;
    required?: boolean;
    allowEmptyValue?: boolean;
    allowReserved?: boolean;
}
export interface ImplicitOAuthFlow extends Extensions {
    authorizationUrl: string;
    refreshUrl?: string;
    scopes: Dictionary<string>;
}
export interface Info extends Extensions {
    title: string;
    description?: string;
    termsOfService?: string;
    contact?: Contact;
    license?: License;
    version: string;
}
export interface License extends Extensions {
    name: string;
    url?: string;
}
export interface Link extends Extensions {
    operationRef?: string;
    operationId?: string;
    parameters?: Dictionary<string>;
    requestBody?: any;
    description?: string;
    server?: Server;
}
export interface MediaType extends Extensions, Partial<HasExample>, Partial<HasExamples> {
    /** A map between a property name and its encoding information. The key, being the property name, MUST exist in the schema as a property. The encoding object SHALL only apply to requestBody objects when the media type is multipart or application/x-www-form-urlencoded. */
    encoding?: Dictionary<Encoding>;
    /** The schema defining the type used for the request body. */
    schema?: Refable<Schema>;
}
export interface NonBearerHTTPSecurityScheme extends Extensions {
    scheme: string;
    description?: string;
    type: SecurityType.Http;
}
export interface OAuth2SecurityScheme extends Extensions {
    type: SecurityType.OAuth2;
    flows: OAuthFlows;
    description?: string;
}
export interface OAuthFlows extends Extensions {
    implicit?: ImplicitOAuthFlow;
    password?: PasswordOAuthFlow;
    clientCredentials?: ClientCredentialsFlow;
    authorizationCode?: AuthorizationCodeOAuthFlow;
}
export interface OpenIdConnectSecurityScheme extends Extensions {
    type: SecurityType.OpenIDConnect;
    openIdConnectUrl: string;
    description?: string;
}
export interface HttpOperation extends Deprecatable, Extensions, Implementation<HttpOperationDetails> {
    tags?: Array<string>;
    summary?: string;
    description?: string;
    externalDocs?: ExternalDocumentation;
    operationId?: string;
    parameters?: ParameterReference<Parameter>[];
    requestBody?: Refable<RequestBody>;
    responses: Dictionary<Refable<Response>>;
    callbacks?: Dictionary<Refable<Callback>>;
    security?: Array<SecurityRequirement>;
    servers?: Array<Server>;
}
export interface Deprecatable {
    deprecated?: boolean;
}
export interface HasSchema {
    schema: Refable<Schema>;
    explode?: boolean;
}
export interface HasContent {
    content: Dictionary<MediaType>;
}
export interface HasExample {
    example: any;
}
export interface HasExamples {
    examples: Dictionary<Refable<HasExample>>;
}
export interface InCookie extends HasSchema, Partial<HasExample>, Partial<HasExamples> {
    in: ParameterLocation.Cookie;
    style?: EncodingStyle.Form;
}
export interface InHeader extends HasSchema, Partial<HasExample>, Partial<HasExamples> {
    in: ParameterLocation.Header;
    style?: EncodingStyle.Simple;
}
export interface InPath extends HasSchema, Partial<HasExample>, Partial<HasExamples> {
    in: ParameterLocation.Path;
    style?: PathEncodingStyle;
}
export interface InQuery extends HasSchema, Partial<HasExample>, Partial<HasExamples> {
    in: ParameterLocation.Query;
    allowReserved?: boolean;
    style?: QueryEncodingStyle;
}
export interface Parameter extends Deprecatable, Partial<HasSchema>, Partial<HasContent>, Partial<HasExample>, Partial<HasExamples>, Extensions {
    name: string;
    in: EnumStr<ParameterLocation>;
    description?: string;
    allowEmptyValue?: boolean;
    required?: boolean;
    style?: EnumStr<EncodingStyle>;
    allowReserved?: boolean;
}
export interface PasswordOAuthFlow extends Extensions {
    tokenUrl: string;
    refreshUrl?: string;
    scopes?: Dictionary<string>;
}
export type HttpMethod = "get" | "put" | "post" | "delete" | "options" | "head" | "patch" | "trace";
export interface PathItem extends Extensions, Partial<Record<HttpMethod, HttpOperation>> {
    $ref?: string | PathItem;
    summary?: string;
    description?: string;
    servers?: Server[];
    parameters?: ParameterReference<Parameter>[];
}
export interface RequestBody extends Extensions {
    description?: string;
    content: Dictionary<MediaType>;
    required?: boolean;
    "x-ms-client-flatten"?: boolean;
    "x-ms-parameter-location"?: string;
}
export interface Response extends Extensions {
    description: string;
    headers?: Dictionary<Refable<Header>>;
    content?: Dictionary<MediaType>;
    links?: Dictionary<Refable<Link>>;
}
export interface Schema extends Deprecatable, Extensions, Implementation<SchemaDetails> {
    type?: EnumStr<JsonType>;
    title?: string;
    description?: string;
    format?: string;
    nullable?: boolean;
    readOnly?: boolean;
    writeOnly?: boolean;
    required?: Array<string>;
    multipleOf?: number;
    maximum?: number;
    exclusiveMaximum?: boolean;
    minimum?: number;
    exclusiveMinimum?: boolean;
    maxLength?: number;
    minLength?: number;
    pattern?: string;
    maxItems?: number;
    minItems?: number;
    uniqueItems?: boolean;
    maxProperties?: number;
    minProperties?: number;
    example?: any;
    default?: any;
    discriminator?: Discriminator;
    externalDocs?: ExternalDocumentation;
    xml?: XML;
    enum?: Array<any>;
    not?: Refable<Schema>;
    allOf?: Array<Refable<Schema>>;
    oneOf?: Array<Refable<Schema>>;
    anyOf?: Array<Refable<Schema>>;
    items?: Refable<Schema>;
    properties?: Dictionary<PropertyReference<Schema>>;
    additionalProperties?: boolean | Refable<Schema>;
}
export interface Server extends Extensions {
    url: string;
    description?: string;
    variables?: Dictionary<ServerVariable>;
}
export interface ServerVariable extends Extensions {
    enum?: Array<string>;
    default: string;
    description?: string;
}
export interface Tag extends Extensions {
    name: string;
    description?: string;
    externalDocs?: ExternalDocumentation;
}
export interface XML extends Extensions {
    name?: string;
    namespace?: string;
    prefix?: string;
    attribute?: boolean;
    wrapped?: boolean;
}
//# sourceMappingURL=oai3.d.ts.map