@aws/pdk
Version:
All documentation is located at: https://aws.github.io/aws-pdk
26 lines (25 loc) • 993 B
TypeScript
/*! Copyright [Amazon.com](http://amazon.com/), Inc. or its affiliates. All Rights Reserved.
SPDX-License-Identifier: Apache-2.0 */
import { Component, Project } from "projen";
import { TypeSafeApiModelBuildOutputOptions } from "./type-safe-api-model-build";
/**
* Output of the OpenAPI to AsyncAPI task
*/
export interface TypeSafeApiAsyncModelBuildOutputOptions {
/**
* Path to the generated AsyncAPI specification (relative to the project root)
*/
readonly asyncApiSpecFile: string;
}
/**
* Options for converting OpenAPI to AsyncAPI
*/
export interface TypeSafeApiAsyncModelBuildOptions extends TypeSafeApiAsyncModelBuildOutputOptions, TypeSafeApiModelBuildOutputOptions {
}
/**
* Adds a task to convert the OpenAPI specification into an AsyncAPI specification,
* which can be used for documentation generation.
*/
export declare class TypeSafeApiAsyncModelBuild extends Component {
constructor(project: Project, options: TypeSafeApiAsyncModelBuildOptions);
}