diff --git a/docs/openapi.yaml b/docs/openapi.yaml index 42fa4ac8a..3a6f1f39d 100644 --- a/docs/openapi.yaml +++ b/docs/openapi.yaml @@ -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. @@ -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 @@ -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: @@ -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