Merge pull request #22 from alexferl/update_schema

update schema
alexferl · Mar 15, 2024 · 1a0be84 · 1a0be84
2 parents 9466eca + 36be7c0
commit 1a0be84
Show file tree

Hide file tree

Showing 7 changed files with 11 additions and 13 deletions.
diff --git a/models/user.go b/models/user.go
@@ -83,7 +83,7 @@ type UserResponse struct {
 	Id        string     `json:"id"`
 	Bio       string     `json:"bio"`
 	CreatedAt *time.Time `json:"created_at"`
-	Email     string     `json:"email"`
+	Email     string     `json:"email,omitempty"`
 	Name      string     `json:"name"`
 	Roles     []string   `json:"-"`
 	UpdatedAt *time.Time `json:"updated_at"`
@@ -138,7 +138,6 @@ func (u *User) AdminResponse() *UserAdminResponse {
 			Id:        u.Id,
 			Bio:       u.Bio,
 			CreatedAt: u.CreatedAt,
-			Email:     u.Email,
 			Name:      u.Name,
 			UpdatedAt: u.UpdatedAt,
 			Username:  u.Username,

diff --git a/openapi/components/schemas/users/User.yaml b/openapi/components/schemas/users/User.yaml
@@ -5,7 +5,6 @@ required:
   - id
   - bio
   - created_at
-  - email
   - is_banned
   - is_locked
   - name

diff --git a/openapi/paths/users/users.yaml b/openapi/paths/users/users.yaml
@@ -1,6 +1,6 @@
 get:
   summary: List users
-  description: Returns a list of users. Admin role required.
+  description: Returns a list of users. Admin or higher role required.
   operationId: listUsers
   security:
     - cookieAuth: []

diff --git a/openapi/paths/users/{username}.yaml b/openapi/paths/users/{username}.yaml
@@ -1,6 +1,6 @@
 get:
   summary: Get a user
-  description: Returns a single user.
+  description: Returns a single user. Admin or higher role will return more fields.
   operationId: getUser
   security:
     - cookieAuth: []
@@ -20,15 +20,15 @@ get:
         application/json:
           schema:
             oneOf:
-              - $ref: '../../components/schemas/users/User.yaml'
               - $ref: '../../components/schemas/users/me/CurrentUser.yaml'
+              - $ref: '../../components/schemas/users/User.yaml'
     '401':
       $ref: '../../components/responses/Unauthorized.yaml'
     '410':
       $ref: '../../components/responses/Gone.yaml'
 patch:
   summary: Update user
-  description: Returns the updated user.
+  description: Returns the updated user. Admin or higher role required.
   operationId: updateUser
   security:
     - cookieAuth: []

diff --git a/openapi/paths/users/{username}_ban.yaml b/openapi/paths/users/{username}_ban.yaml
@@ -1,6 +1,6 @@
 put:
   summary: Ban a user
-  description: Bans a user.
+  description: Bans a user. Admin or higher role required.
   operationId: banUser
   security:
     - cookieAuth: []
@@ -26,7 +26,7 @@ put:
       $ref: '../../components/responses/Gone.yaml'
 delete:
   summary: Unban a user
-  description: Unbans a user.
+  description: Unbans a user. Admin or higher role required.
   operationId: unbanUser
   security:
     - cookieAuth: []

diff --git a/openapi/paths/users/{username}_lock.yaml b/openapi/paths/users/{username}_lock.yaml
@@ -1,6 +1,6 @@
 put:
   summary: Lock a user
-  description: Locks a user.
+  description: Locks a user. Admin or higher role required.
   operationId: lockUser
   security:
     - cookieAuth: []
@@ -26,7 +26,7 @@ put:
       $ref: '../../components/responses/Gone.yaml'
 delete:
   summary: Unlock a user
-  description: Unlocks a user.
+  description: Unlocks a user. Admin or higher role required.
   operationId: unlockUser
   security:
     - cookieAuth: []

diff --git a/openapi/paths/users/{username}_roles_{role}.yaml b/openapi/paths/users/{username}_roles_{role}.yaml
@@ -1,6 +1,6 @@
 put:
   summary: Add user role
-  description: Adds a role to the user.
+  description: Adds a role to the user. Admin or higher role required.
   operationId: addRole
   security:
     - cookieAuth: []
@@ -34,7 +34,7 @@ put:
       $ref: '../../components/responses/UnprocessableEntity.yaml'
 delete:
   summary: Remove user role
-  description: Removes a role from the user.
+  description: Removes a role from the user. Admin or higher role required.
   operationId: removeRole
   security:
     - cookieAuth: []