Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore(appsync): Change reference of API source in comments to Definition #27831

Merged
merged 2 commits into from
Nov 4, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions packages/aws-cdk-lib/aws-appsync/lib/graphqlapi.ts
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand All @@ -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));
Expand All @@ -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 {
Expand Down Expand Up @@ -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;
/**
Expand Down