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

Add inflection comment directive to the SQL schema in the README #579

Merged
merged 1 commit into from
Feb 27, 2025

Conversation

MrPiao
Copy link
Contributor

@MrPiao MrPiao commented Feb 25, 2025

What kind of change does this PR introduce?

  • Documentation (README) update only.

This PR updates the SQL schema in the TL;DR section of the README to include the inflection comment directive, especially since the screenshot below has inflected field and type names.

While I was trying to figure out if there was a way to do this using supabase / pg_graphql, the README in this repo was confusing because the screenshot clearly showed what I wanted (camelCase and PascalCase in my GraphQL schema), yet I wasn't getting that in my own project. Because this feature is super useful but not very well documented (at least visibility-wise), I think it would benefit folks to just show that this feature is available front and center.

I will probably follow up with another PR / doc suggestion for the main supabase documentation as well.

Update the SQL schema to include the inflection comment directive, especially since the screenshot below has inflected field and type names.
@MrPiao
Copy link
Contributor Author

MrPiao commented Feb 26, 2025

I did realize there is documentation available in the main Supabase docs, which has the same content as the pg_graphql docs, that touch upon this. I'll have to think about how to make it more visible or searchable there.

Still, this proposed change should still be valid since screenshot shows inflected values!

@imor imor merged commit b0aa275 into supabase:master Feb 27, 2025
7 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants