-
Notifications
You must be signed in to change notification settings - Fork 296
Use correct URL path and query param for athenz role. #3089
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
- Add 'domain' to URL path - Update attribute athenzRole -> athenzRoleName Signed-off-by: Gjoran Voldengen <[email protected]>
Summary of ChangesHello @gjoranv, 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 refines the API contract for Azure identity access tokens by correcting the ZTS API endpoint structure. It ensures that the URL path for obtaining credentials properly includes the 'domain' segment and updates the attribute name for specifying the Athenz role, thereby improving the accuracy and maintainability of the integration documentation. Highlights
Using Gemini Code AssistThe 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 by creating a comment using either
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 Limitations & Feedback Gemini Code Assist 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. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. 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
|
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 updates the documentation to use the correct URL path and attribute name for obtaining Azure credentials for an Athenz role. The changes are accurate and improve the clarity of the design document.
| "clientId": "coretech.azure", | ||
| "attributes": { | ||
| "athenzRole": "azure-log-reader", | ||
| "athenzRoleName": "azure-log-reader", |
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.
This change to athenzRoleName is correct. However, I noticed that the JSON example in this code block is not valid, which could be confusing for users. On line 134, a smart quote (“) is used instead of a regular double quote ("), and the value for azureScope is a placeholder which is not a valid JSON value. While this is on an unchanged line, I'd recommend fixing it to make the example valid. For instance, you could change line 134 to "azureScope": "<scope>" and mention the optionality and default value in the text.
See issue #3088
Description
Use correct URL path and query param for athenz role.
Contribution Checklist:
Attach Screenshots (Optional)