-
Notifications
You must be signed in to change notification settings - Fork 0
feat(schema): add optional operator field to Wiki schema #110
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
Added an optional `operator` field to the Wiki schema to support additional user roles. This change allows for tracking users who publish through Sophia
🦋 Changeset detectedLatest commit: f830dca 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 @Yomzy2223, 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 introduces a new capability to track the specific user (referred to as an 'operator') responsible for publishing content through the Sophia platform. By adding an optional 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 introduces an optional operator field to the Wiki schema, which is a useful addition for tracking editors. The change is implemented correctly. I have one suggestion to improve code maintainability by refactoring a duplicated schema definition.
| events: z.array(BaseEvents).nullish(), | ||
| user: z.object({ id: z.string() }), | ||
| author: z.object({ id: z.string() }), | ||
| operator: z.object({ id: z.string() }).optional(), |
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.
The structure z.object({ id: z.string() }) is now duplicated across user, author, and the newly added operator fields. To improve maintainability and adhere to the DRY (Don't Repeat Yourself) principle, I suggest creating a reusable schema for this structure.
You could define a new schema in the 'Supporting Schemas' section, similar to other base types in this file:
export const UserReference = z.object({ id: z.string() });Then, you can use it for user, author, and operator fields like so:
user: UserReference,
author: UserReference,
operator: UserReference.optional(),This will make the Wiki schema cleaner and easier to manage if the user reference structure ever needs to be changed.
What kind of change does this PR introduce? feature
What is the current behavior? there's currently no way to track which editor makes use of Sophia
What is the new behavior (if this is a feature change)? this PR adds an optional
operatorfield to the Wiki schema to allows for tracking users who publish through Sophia