Skip to content

docs(api-spec): add project displayName field #2830

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.

Sign up for GitHub

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

Open
aofei wants to merge 1 commit into
base: dev
Choose a base branch
from
Open

docs(api-spec): add project displayName field #2830

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 14 additions & 2 deletions docs/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,9 @@ paths:
- $ref: "#/components/schemas/ProjectReleaseFullName"
name:
$ref: "#/components/schemas/Project/properties/name"
displayName:
description: Defaults to `name` if not provided.
$ref: "#/components/schemas/Project/properties/displayName"
files:
description: |
File paths and their corresponding universal URLs associated with the project.
Expand Down Expand Up @@ -267,10 +270,12 @@ paths:
- $ref: "#/components/schemas/ProjectFullName"
- $ref: "#/components/schemas/ProjectReleaseFullName"
- name: keyword
description: Filter projects by name pattern.
description: Filter projects by display name or name pattern.
in: query
schema:
$ref: "#/components/schemas/Project/properties/name"
type: string
examples:
- Niu Xiao Qi
- name: visibility
description: Filter projects by visibility.
in: query
Expand Down Expand Up @@ -400,6 +405,8 @@ paths:
$ref: "#/components/schemas/Project/properties/files"
visibility:
$ref: "#/components/schemas/Project/properties/visibility"
displayName:
$ref: "#/components/schemas/Project/properties/displayName"
description:
$ref: "#/components/schemas/Project/properties/description"
instructions:
Expand Down Expand Up @@ -2550,6 +2557,11 @@ components:
type: string
examples:
- NiuXiaoQi
displayName:
description: Display name of the project.
type: string
examples:
- Niu Xiao Qi
version:
description: Version number of the project.
type: integer
Expand Down