Skip to content

Conversation

@gjoranv
Copy link
Contributor

@gjoranv gjoranv commented Oct 3, 2025

See issue #3088

Description

Use correct URL path and query param for athenz role.

  • Add 'domain' to URL path
  • Update attribute athenzRole -> athenzRoleName

Contribution Checklist:

  • [ x] The pull request does not introduce any breaking changes
  • [x ] I have read the contribution guidelines.
  • [x ] Create an issue and link to the pull request.

Attach Screenshots (Optional)

- Add 'domain' to URL path
- Update attribute athenzRole -> athenzRoleName

Signed-off-by: Gjoran Voldengen <[email protected]>
@gemini-code-assist
Copy link
Contributor

Summary of Changes

Hello @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

  • URL Path Correction: The ZTS API URL path for obtaining Azure credentials has been updated to include '/domain' before the Athenz domain name, specifically changing 'external/azure//creds' to 'external/azure/domain//creds'.
  • Attribute Name Update: The attribute used to specify the Athenz role in the request body has been renamed from 'athenzRole' to 'athenzRoleName' for clarity and consistency.
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 by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

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 pull request 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 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

  1. 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.

Copy link
Contributor

@gemini-code-assist gemini-code-assist bot left a 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",
Copy link
Contributor

Choose a reason for hiding this comment

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

medium

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.

@havetisyan havetisyan merged commit b5a23c7 into AthenZ:master Oct 3, 2025
1 check 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