@autorest/modelerfour/dist/modeler/interpretations.d.ts

AutoRest Modeler Version Four (component)

import { ChoiceSchema, XmlSerlializationFormat, ExternalDocumentation, ApiVersion, Deprecation, ChoiceValue } from "@autorest/codemodel";
import { Session } from "@autorest/extension-base";
import * as OpenAPI from "@azure-tools/openapi";
export interface XMSEnum {
    modelAsString?: boolean;
    values: [{
        value: any;
        description?: string;
        name?: string;
    }];
    name: string;
}
export declare function getValidEnumValueName(originalString: string): string;
export declare class Interpretations {
    private session;
    isTrue(value: any): boolean;
    getConstantValue(schema: OpenAPI.Schema, value: any): any;
    isApiVersionParameter(parameter: OpenAPI.Parameter | OpenAPI.ServerVariable): boolean;
    getEnumChoices(schema: OpenAPI.Schema): Array<ChoiceValue>;
    isEmptyObject(schema: OpenAPI.Schema): boolean;
    getSerialization(schema: OpenAPI.Schema): any | undefined;
    getXmlSerialization(schema: OpenAPI.Schema): XmlSerlializationFormat | undefined;
    getExternalDocs(item: {
        externalDocs?: OpenAPI.ExternalDocumentation;
    }): ExternalDocumentation | undefined;
    getExample(schema: OpenAPI.Schema): any;
    getApiVersions(schema: OpenAPI.Schema | OpenAPI.HttpOperation | OpenAPI.PathItem): Array<ApiVersion> | undefined;
    getApiVersionValues(node: OpenAPI.Schema | OpenAPI.HttpOperation | OpenAPI.PathItem | OpenAPI.Info): Array<string>;
    getDeprecation(schema: OpenAPI.Deprecatable): Deprecation | undefined;
    constructor(session: Session<OpenAPI.Model>);
    xmsMeta(obj: any, key: string): any;
    xmsMetaFallback(obj: any, obj2: any, key: string): any;
    splitOpId(opId: string): {
        group: string;
        member: string;
    };
    isBinarySchema(schema: OpenAPI.Schema | undefined): boolean;
    getOperationId(httpMethod: string, path: string, original: OpenAPI.HttpOperation): {
        member: string;
        group: string;
        operationId?: string;
    };
    getDescription(defaultValue: string, original: OpenAPI.Extensions & {
        title?: string;
        summary?: string;
        description?: string;
    }): string;
    getPreferredName(original: any, preferredName?: string, fallbackName?: string): any;
    getName(defaultValue: string, original: any): string;
    /** gets the operation path from metadata, falls back to the OAI3 path key */
    getPath(pathItem: OpenAPI.PathItem, operation: OpenAPI.HttpOperation, path: string): any;
    getEnumSchemaForVarible(name: string, somethingWithEnum: {
        enum?: Array<string>;
    }): ChoiceSchema;
    getExtensionProperties(dictionary: Record<string, any>, additional?: Record<string, any>): Record<string, any> | undefined;
    getClientDefault(dictionary: Record<string, any>, additional?: Record<string, any>): string | number | boolean | undefined;
    static getExtensionProperties(dictionary: Record<string, any>): Record<string, any> | undefined;
}
//# sourceMappingURL=interpretations.d.ts.map