Update Serving API - from backend PR #5454 - #322
Conversation
![gemini-code-assist[bot]](https://avatars.githubusercontent.com/in/956858?s=60&v=4){kind=small}
There was a problem hiding this comment.
Summary of Changes
Hello @clllaur, 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 updates the TypeScript Serving API definitions to align with recent backend changes. The primary focus is on enhancing the clarity and completeness of the API documentation through improved JSDoc comments, introducing new types for file handling and concurrency control, and refining existing data structures to better reflect current backend functionalities.
Highlights
- Enhanced API Documentation: Numerous JSDoc comments for existing types have been significantly improved for clarity, precision, and added context, making the API definitions more understandable (e.g., PageNumber, Pagination, SortDirection, RuleObject, LocationTriggerTypes).
- New API Types Introduced: New types such as
UploadedFileDatafor describing file objects andConcurrencyKeyfor optimistic concurrency control in API updates have been added. - Updated Experience Change Models: The
ExperienceChangerelated types now include an optionalconcurrency_keyto support optimistic locking, and a newExperienceChangeServingtype has been introduced and integrated intoExperienceVariationConfig. - Refined Project Configuration: The
environmentsproperty has been removed from theConfigProjecttype, and the description forglobal_javascriptwithinConfigProjecthas been clarified.
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 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
-
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.
Code Review
This pull request updates the TypeScript Serving API types, primarily by enhancing the JSDoc comments to be much more descriptive and clear. This is a significant improvement for developers using the API. The changes also introduce a concurrency_key for optimistic locking on various ExperienceChange types and add corresponding ...Serving type variants. Overall, the changes are positive, but I've identified a couple of minor copy-paste errors in the comments that should be corrected for consistency.
| }; | ||
|
|
||
| /** | ||
| * Describes structure for "defaultCode" type of experience change |
There was a problem hiding this comment.
The JSDoc for ExperienceChangeRichStructureDataServing seems to have a copy-paste error. It currently states it's for a "defaultCode" type, but it should be for "richStructure" to match the type name.
| * Describes structure for "defaultCode" type of experience change | |
| * Describes structure for "richStructure" type of experience change |
| }; | ||
|
|
||
| /** | ||
| * Describes structure for "defaultCode" type of experience change |
There was a problem hiding this comment.
Similar to the previous comment, the JSDoc for ExperienceChangeCustomCodeDataServing appears to be incorrect. It mentions "defaultCode" but should refer to "customCode" to align with the type it's documenting.
| * Describes structure for "defaultCode" type of experience change | |
| * Describes structure for "customCode" type of experience change |
2 participants
Updating TS Serving API after the latest changes from backend repo,
PR #5454