update API for creating user, updating password and comment post return.

This commit is contained in:
wy65701436 2016-05-02 20:58:50 -07:00
parent 9c655e710b
commit 2a461ee53e

View File

@ -109,7 +109,7 @@ paths:
tags:
- Products
responses:
200:
201:
description: Project created successfully.
400:
description: Unsatisfied with constraints of the project creation.
@ -383,6 +383,56 @@ paths:
description: User does not have permission of admin role.
500:
description: Unexpected internal errors.
post:
summary: Creates a new user account.
description: |
This endpoint is to create a user if the user does not already exist.
parameters:
- name: username
in: body
type: string
format: string
required: true
description: The username of the new created user. Maximum of 20
characters.
- name: password
in: body
type: string
format: string
required: true
description: The password of the new created user. Maximum of 20
characters.
- name: email
in: body
type: string
format: string
required: true
description: Publicly visible email address of the new created user.
- name: realname
in: body
type: string
format: string
required: true
description: Full name associated with the new created user.
Maximum of 20 characters.
- name: comment
in: body
type: string
format: string
required: false
description: Comments associated with the new created user.
Maximum of 30 characters.
tags:
- Products
responses:
201:
description: User created successfully.
400:
description: Unsatisfied with constraints of the user creation.
403:
description: User registration can only be used by admin role user when self-registration is off.
500:
description: Unexpected internal errors.
/users/{user_id}:
put:
summary: Update a registered user to change to be an administrator of Harbor.
@ -438,6 +488,48 @@ paths:
description: User ID does not exist.
500:
description: Unexpected internal errors.
/users/{user_id}/password:
put:
summary: Change the password on a user that already exists.
description: |
This endpoint is for user to update password. Users with the admin
role can change any user's password. Guest users can change only
their own password.
parameters:
- name: user_id
in: path
type: integer
format: int32
required: true
description: Registered user ID.
parameters:
- name: old_password
in: body
type: string
format: string
required: true
description: The user's existing password.
parameters:
- name: new_password
in: body
type: string
format: string
required: true
description: New password for marking as to be updated.
tags:
- Products
responses:
200:
description: Updated password successfully.
400:
description: Invalid user ID; Old password is blank; New password
is blank.
401:
description: Old password is not correct.
403:
description: Guests can only change their own account.
500:
description: Unexpected internal errors.
/repositories:
get:
summary: Get repositories accompany with relevant project and repo name.