From 7c497ee998976b69ad1e2cd3e68f30cb593f8ded Mon Sep 17 00:00:00 2001 From: Nicholas DeJaco <54116900+ndejaco2@users.noreply.github.com> Date: Fri, 3 Nov 2023 18:24:09 -0700 Subject: [PATCH] chore(appsync): Change reference of API source in comments to Definition (#27831) Fixes issue with code comments ---- *By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license* --- packages/aws-cdk-lib/aws-appsync/lib/graphqlapi.ts | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/packages/aws-cdk-lib/aws-appsync/lib/graphqlapi.ts b/packages/aws-cdk-lib/aws-appsync/lib/graphqlapi.ts index 1fd051cfe4af3..f6b19fedbea4e 100644 --- a/packages/aws-cdk-lib/aws-appsync/lib/graphqlapi.ts +++ b/packages/aws-cdk-lib/aws-appsync/lib/graphqlapi.ts @@ -336,7 +336,7 @@ export abstract class Definition { /** * Schema from schema object. * @param schema SchemaFile.fromAsset(filePath: string) allows schema definition through schema.graphql file - * @returns API Source with schema from file + * @returns Definition with schema from file */ public static fromSchema(schema: ISchema): Definition { return { @@ -347,7 +347,7 @@ export abstract class Definition { /** * Schema from file, allows schema definition through schema.graphql file * @param filePath the file path of the schema file - * @returns API Source with schema from file + * @returns Definition with schema from file */ public static fromFile(filePath: string): Definition { return this.fromSchema(SchemaFile.fromAsset(filePath)); @@ -356,7 +356,7 @@ export abstract class Definition { /** * Schema from existing AppSync APIs - used for creating a AppSync Merged API * @param sourceApiOptions Configuration for AppSync Merged API - * @returns API Source with for AppSync Merged API + * @returns Definition with for AppSync Merged API */ public static fromSourceApis(sourceApiOptions: SourceApiOptions): Definition { return { @@ -409,7 +409,7 @@ export interface GraphqlApiProps { * SchemaFile.fromAsset(filePath: string) allows schema definition through schema.graphql file * * @default - schema will be generated code-first (i.e. addType, addObjectType, etc.) - * @deprecated use apiSource.schema instead + * @deprecated use Definition.schema instead */ readonly schema?: ISchema; /**