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

Docs Request: Improve documentation around Querying against an @index (GSI) for Android API Category #1930

Open
1 task done
alharris-at opened this issue Aug 31, 2022 · 0 comments
Labels
api documentation Documentation improvements feature-request Request a new feature GraphQL API Related to the API (GraphQL) category/plugins

Comments

@alharris-at
Copy link
Contributor

Before opening, please confirm:

Language and Async Model

Not applicable

Amplify Categories

GraphQL API

Gradle script dependencies

N/A

Environment information

N/A

Please include any relevant guides or documentation you're referencing

https://docs.amplify.aws/lib/graphqlapi/query-data/q/platform/android/ and https://docs.amplify.aws/lib/graphqlapi/advanced-workflows/q/platform/android/#nested-data

Describe the feature request

Add some docs describing how to query for non-standard queries against defined indexes.

Basic usecase ends up returning null for field values, but you can serialize to a string to retrieve data, getting the paginated results is a little more complicated, and not documented today.

Retrieving as a string: https://gist.github.com/alharris-at/4ab46c9f2bb96aae2045064753e187eb
Deserializing to a PaginatedResult: https://gist.github.com/alharris-at/e34341bdb7fd197d5d8ceecee5bc2070

Initialization steps (if applicable)

No response

Code Snippet

See Gists

amplifyconfiguration.json

No response

GraphQL Schema

// Put your schema below this line

Additional information and screenshots

No response

@alharris-at alharris-at added feature-request Request a new feature GraphQL API Related to the API (GraphQL) category/plugins documentation Documentation improvements labels Aug 31, 2022
@lawmicha lawmicha added the api label Sep 7, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
api documentation Documentation improvements feature-request Request a new feature GraphQL API Related to the API (GraphQL) category/plugins
Projects
None yet
Development

No branches or pull requests

2 participants