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

Improve the update application data documentation #3545

Open
kafejo opened this issue Feb 29, 2024 · 1 comment
Open

Improve the update application data documentation #3545

kafejo opened this issue Feb 29, 2024 · 1 comment
Labels
api Issues related to the API category documentation Documentation improvements

Comments

@kafejo
Copy link

kafejo commented Feb 29, 2024

Is your feature request related to a problem? Please describe.

When it comes to mutating data, there's a very little documentation about how to do it. Actually just one line that contains a typo.

image

https://docs.amplify.aws/swift/build-a-backend/graphqlapi/mutate-data/#update-an-item

Describe the solution you'd like

It would be nice to have more complex example including the use of update parameters where and includes.

Describe alternatives you've considered

I tried to examine the codebase to learn how to use includes but not really sure what's the best practice here. No documentation comments in the codebase either.

Is the feature request related to any of the existing Amplify categories?

API

Additional context

No response

@phantumcode phantumcode added the documentation Documentation improvements label Feb 29, 2024
@phantumcode
Copy link
Member

@kafejo Thanks for submitting your request, we'll prioritize the issue and post updates here.

@phantumcode phantumcode added the api Issues related to the API category label Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api Issues related to the API category documentation Documentation improvements
Projects
None yet
Development

No branches or pull requests

2 participants