Skip to content
New issue

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

#

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

Already on GitHub? # to your account

Jump to bottom

(appsync): wrong suggestion for deprecated schema property #27895

Closed
daschaa opened this issue Nov 8, 2023 · 3 comments
Closed

(appsync): wrong suggestion for deprecated schema property #27895

daschaa opened this issue Nov 8, 2023 · 3 comments
Labels
@aws-cdk/aws-appsync Related to AWS AppSync documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2 response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days.

Comments

@daschaa
Copy link
Contributor

daschaa commented Nov 8, 2023

Describe the issue

For the property schema in appsync.GraphqlApi I see the following documentation:

GraphQL schema definition. Specify how you want to define your schema.
SchemaFile.fromAsset(filePath: string) allows schema definition through schema.graphql file Deprecated: use apiSource.schema instead

However, there is no property apiSource. I think it's misleading and should be corrected.

Links

https://docs.aws.amazon.com/cdk/api/v2/docs/aws-cdk-lib.aws_appsync.GraphqlApiProps.html#schemaspan-classapi-icon-api-icon-deprecated-titlethis-api-element-is-deprecated-its-use-is-not-recommended%EF%B8%8Fspan
@daschaa daschaa added documentation This is a problem with documentation. needs-triage This issue or PR still needs to be triaged. labels Nov 8, 2023
@github-actions github-actions bot added the @aws-cdk/aws-appsync Related to AWS AppSync label Nov 8, 2023
@khushail khushail added investigating This issue is being investigated and/or work is in progress to resolve the issue. and removed needs-triage This issue or PR still needs to be triaged. labels Nov 8, 2023
@pahud
Copy link
Contributor

pahud commented Nov 8, 2023 •
edited
Loading

aws-cdk/packages/aws-cdk-lib/aws-appsync/lib/graphqlapi.ts

Line 412 in 412fb9f

* @deprecated use Definition.schema instead

The latest source says "use Definition.schema" instead, which was updated 5 days ago. The doc will be updated in the next release.

@pahud pahud added response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days. p2 effort/small Small work item – less than a day of effort and removed investigating This issue is being investigated and/or work is in progress to resolve the issue. labels Nov 8, 2023
@daschaa
Copy link
Contributor Author

daschaa commented Nov 9, 2023

@pahud awesome thanks!

@daschaa daschaa closed this as completed Nov 9, 2023
@github-actions GitHub Actions
Copy link

github-actions bot commented Nov 9, 2023

⚠️COMMENT VISIBILITY WARNING⚠️

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.

@github-actions github-actions bot mentioned this issue Dec 1, 2023
Closed
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
@aws-cdk/aws-appsync Related to AWS AppSync documentation This is a problem with documentation. effort/small Small work item – less than a day of effort p2 response-requested Waiting on additional info and feedback. Will move to "closing-soon" in 7 days.
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@pahud @daschaa @khushail