Review Graphql Spec

Step 2: Report Validation Errors

If validation errors are found:

1. Display each error clearly to the user
2. Provide a brief explanation of what the error means
3. Suggest a solution for each error

Step 3: Review Against Enterprise Standards

1. Analyze the schema files against enterprise guidelines (see Enterprise GraphQL Guidelines)
2. Check for:
   • Naming conventions compliance
   • Required documentation (descriptions, @deprecated directives)
   • Best practices adherence
   • Security considerations
   • Best usage of available built-in scalars and custom scalars provided by TheGuild's graphql-scalars package

Step 4: Report Standards Violations

If standards violations are found:

1. Display each violation with context
2. Provide a brief explanation of why it violates the standard
3. Suggest remediation steps
4. Offer to fix the violations found

Troubleshooting

References

• Enterprise GraphQL Guidelines - Internal standards for schema design and documentation
• GraphQL Official Documentation: https://graphql.org/learn/
• TheGuild's Custom Scalars: https://the-guild.dev/graphql/scalars/docs/scalars/account-number
• Best Practices: https://graphql.org/learn/best-practices/

Example Output

When reviewing a schema, the output should be structured like:

VALIDATION RESULTS
==================
✓ Schema syntax is valid

STANDARDS REVIEW RESULTS
========================
⚠ Type "User" missing description
⚠ Field "createdAt" should use @deprecated directive
✗ Query naming does not follow camelCase convention