-
Notifications
You must be signed in to change notification settings - Fork 1k
Set @auth(insecureReason)
in init template
#8863
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
Conversation
@auth(insecureReason)
in template@auth(insecureReason)
in init template
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Summary of Changes
Hello @fredzqm, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!
This pull request enhances the clarity and documentation of authentication configurations within the Data Connect GraphQL templates. I've introduced the insecureReason
argument to existing @auth
directives, providing explicit justifications for the chosen authentication levels (e.g., PUBLIC
or USER_EMAIL_VERIFIED
) for various operations. This change improves the understandability of the security posture for generated GraphQL APIs.
Highlights
- Authentication Directives: I've updated the
mutations.gql
template to include theinsecureReason
argument for the@auth
directive on theCreateMovie
mutation. This provides explicit justification for theUSER_EMAIL_VERIFIED
authentication level. - Query Authentication Clarity: I've added the
insecureReason
argument to the@auth(level: PUBLIC)
directives for theListMovies
,GetMovieById
, andSearchMovie
queries in thequeries.gql
template. This clarifies why these operations are publicly accessible.
Using Gemini Code Assist
The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.
Invoking Gemini
You can request assistance from Gemini at any point in your pull request via creating an issue comment (i.e. comment on the pull request page) using either /gemini <command>
or @gemini-code-assist <command>
. Below is a summary of the supported commands.
Feature | Command | Description |
---|---|---|
Code Review | /gemini review |
Performs a code review for the current pull request in its current state. |
Pull Request Summary | /gemini summary |
Provides a summary of the current pull request in its current state. |
Comment | @gemini-code-assist | Responds in comments when explicitly tagged, both in issue comments and review comments. |
Help | /gemini help |
Displays a list of available commands. |
Customization
To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/
folder in the base of the repository. Detailed instructions can be found here.
Limitations & Feedback
Gemini Code Assist is currently in preview and may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments to provide feedback.
You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.
Footnotes
-
Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request adds the insecureReason
argument to @auth
directives in the Data Connect initialization templates. This is a good change as it encourages developers to document their security choices. The implementation is straightforward. I've found a minor typo in one of the reason strings and suggested a fix.
@@ -2,7 +2,7 @@ | |||
|
|||
# # Create a movie based on user input | |||
# mutation CreateMovie($title: String!, $genre: String!, $imageUrl: String!) | |||
# @auth(level: USER_EMAIL_VERIFIED) { | |||
# @auth(level: USER_EMAIL_VERIFIED, insecureReason: "Any emailed verified users can create a new movie.") { |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@rosalyntan Some simple ideas to demonstrate how @auth(insecureReason) does. Please take a look |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
The CLI init template should populate
@auth(insecureReason)
~This should get rid of the warning in code lab.