@autorest/codemodel
Version:
AutoRest code model library
28 lines • 1.11 kB
TypeScript
import { DeepPartial } from "@azure-tools/codegen";
import { ApiVersions } from "./api-version";
import { Deprecation } from "./deprecation";
import { ExternalDocumentation } from "./external-documentation";
import { Metadata } from "./metadata";
/** the base interface that represents an aspect of the model. */
export interface Aspect extends Metadata {
/** a short description
*
* @note - this should not be the description over again.
*/
summary?: string;
/** API versions that this applies to. Undefined means all versions */
apiVersions?: ApiVersions;
/**
* Represent the deprecation information if api is deprecated.
* @default undefined
*/
deprecated?: Deprecation;
/** where did this aspect come from (jsonpath or 'modelerfour:<soemthing>') */
origin?: string;
/** External Documentation Links */
externalDocs?: ExternalDocumentation;
}
export declare class Aspect extends Metadata implements Aspect {
constructor($key: string, description: string, initializer?: DeepPartial<Aspect>);
}
//# sourceMappingURL=aspect.d.ts.map