fix(services): add admin-directory alias for Admin SDK Directory API#710
fix(services): add admin-directory alias for Admin SDK Directory API#710nuthalapativarun wants to merge 1 commit intogoogleworkspace:mainfrom
Conversation
admin-reports implies audit/usage reporting, not user/group management.
Accessing the Directory API currently requires the unintuitive command:
gws admin-reports --api-version directory_v1 users list ...
Adds admin-directory and directory as first-class aliases for
(admin, directory_v1) so agents and users can discover it naturally:
gws admin-directory users list --params '{"domain":"example.com"}'
gws admin-directory groups list --params '{"domain":"example.com"}'
Adds unit tests for both new aliases.
Fixes googleworkspace#473
🦋 Changeset detectedLatest commit: 1462c9b The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
Summary of ChangesHello, 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 improves the discoverability and usability of the Admin SDK Directory API within the CLI. By introducing intuitive aliases, it removes the need for users to rely on the less descriptive 'admin-reports' command or complex version overrides, streamlining common administrative tasks. 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. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request introduces the admin-directory and directory aliases for the Admin SDK Directory API to improve discoverability and separate it from reporting services. It includes a new ServiceEntry in the services configuration and corresponding unit tests to verify the alias resolution. I have no feedback to provide.
Problem
The Admin SDK Directory API (
admin/directory_v1) is one of the most commonly used Google Workspace APIs for managing users, groups, and OUs. Accessing it currently requires the unintuitive command:gws admin-reports --api-version directory_v1 users list --params '{"domain":"example.com"}'admin-reportsimplies audit/usage reporting, not directory management. The version override syntax is also non-obvious and not documented anywhere prominent.Fix
Adds
admin-directoryanddirectoryas first-class aliases for(admin, directory_v1)in the service registry:The existing
admin-reports/reportsaliases are unchanged.Adds unit tests asserting both
admin-directoryanddirectoryresolve to("admin", "directory_v1").Fixes #473