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

W-16028081 ESLint plugin lwc mobild repo docs #70

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

clivewong
Copy link
Contributor

What does this PR do?

Add md docs to ESLint plugin lwc mobild repo

What issues does this PR fix or reference?

W-16028081

@@ -0,0 +1,55 @@
# no-more-than-1-parent-record

This rule flags queries that fetch child entities fetching more than 1 parent record with GraphQL. To resolve this error, set the parent's 'first' argument value to 1.
Copy link
Collaborator

@khawkins khawkins Oct 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This rule flags queries that fetch child entities fetching more than 1 parent record with GraphQL. To resolve this error, set the parent's 'first' argument value to 1.
For GraphQL queries containing parent records with child entities, Offline GraphQL does not support retrieving more than one parent record using the 'first' argument. To resolve this error, set the parent's 'first' argument value to 1.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

NB: Where is this limitation documented? I don't grok it from Feature Limitations of Offline GraphQL
. Cc: @haifeng-li-at-salesforce @ben-zhang-at-salesforce

@@ -0,0 +1,25 @@
# unsupoorted-scope
Copy link
Collaborator

@khawkins khawkins Oct 25, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
# unsupoorted-scope
# unsupported-scope

@@ -0,0 +1,25 @@
# unsupoorted-scope

This rule flags the use scopes other than "MINE" and "ASSIGNEDTOME" with GraphQL. Currently, "MINE" is supported for all entities and "ASSIGNEDTOME" is supported for ServiceAppoinment. No other scopes are supported for GraphQL offline use cases.
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
This rule flags the use scopes other than "MINE" and "ASSIGNEDTOME" with GraphQL. Currently, "MINE" is supported for all entities and "ASSIGNEDTOME" is supported for ServiceAppoinment. No other scopes are supported for GraphQL offline use cases.
This rule flags the use of scopes other than "MINE" and "ASSIGNEDTOME" with GraphQL. Currently, "MINE" is supported for all entities and "ASSIGNEDTOME" is supported for ServiceAppoinment. No other scopes are supported for GraphQL offline use cases.

Copy link
Collaborator

@khawkins khawkins left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's all I had. Looks good over all!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants