docs(api-spec): add project displayName field

[aofei]

Add displayName to the Project schema and related endpoints:

• Add optional displayName to POST /project request body, which defaults to name if not provided
• Add optional displayName to PUT /project/{owner}/{name} request body
• Update keyword parameter in GET /projects/list to search by display name or name, and decouple its schema from Project.name

[gemini-code-assist]

Summary of Changes

Hello @aofei, I'm Gemini Code Assist¹! 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 enhances the project API by introducing a displayName field, allowing projects to have a more descriptive and readable name separate from their technical identifier. This change impacts project creation, updating, and listing functionalities, providing improved search capabilities and a better user experience for identifying projects.

Highlights

• API Schema Update: The Project schema has been extended to include an optional displayName field, providing a more user-friendly identifier for projects.
• Project Creation Endpoint: The POST /project endpoint now accepts an optional displayName in its request body, which will default to the project's name if not explicitly provided.
• Project Update Endpoint: The PUT /project/{owner}/{name} endpoint has been updated to allow modification of the displayName field for existing projects.
• Project Listing Endpoint: The GET /projects/list endpoint's keyword parameter can now search projects by either their displayName or name, and its schema has been decoupled from the Project.name definition for greater flexibility.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Changelog

• docs/openapi.yaml
  • Added displayName property to the Project schema definition.
  • Included displayName as an optional field in the request body for POST /project.
  • Included displayName as an optional field in the request body for PUT /project/{owner}/{name}.
  • Updated the description for the keyword parameter in GET /projects/list to reflect searching by display name or name.
  • Modified the schema for the keyword parameter in GET /projects/list to be a generic string type, decoupling it from the Project.name schema.

Activity

• No human activity has been recorded on this pull request yet.

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

[Copilot]

Pull request overview

Updates the OpenAPI 3.1 spec to introduce an optional displayName for projects and reflect related request/query behavior in the documented endpoints.

Changes:

• Add displayName to the Project schema and to POST /project + PUT /project/{owner}/{name} request bodies.
• Update GET /projects/list keyword query parameter to search by display name or name, and decouple it from Project.name’s schema.

---

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

[xgopilot]

Code Review Summary

The PR adds displayName to the Project schema cleanly and follows existing patterns well. The changes are well-structured with good schema reuse via $ref. One noteworthy inconsistency was identified regarding behavior documentation between POST and PUT endpoints.

[gemini-code-assist]

Code Review

This pull request updates the OpenAPI specification to introduce a displayName for projects. This new field is integrated into the Project schema, the project creation (POST /project) and update (PUT /project/{owner}/{name}) endpoints, and the project listing endpoint (GET /projects/list) is updated to allow searching by displayName. The changes are clear and align with the stated objectives. I've added one suggestion to include a maxLength constraint on the new displayName property to enhance data validation and clarify the API contract for consumers.