Skip to content

Commit

Permalink
Enhance API documentation by adding summaries for user assignment end…
Browse files Browse the repository at this point in the history
…points and removing unused patch operation details
  • Loading branch information
raikbitters committed Jan 22, 2025
1 parent 6a4e0bc commit 8a07e50
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 39 deletions.
4 changes: 2 additions & 2 deletions api/openapi/apis/projects.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ paths:
project_role:
$ref: ../enums/projectRole.yaml
delete:
summary: ''
summary: 'Unassign user from project'
operationId: delete-projects-project_id-users-user_id
responses:
'200':
Expand All @@ -123,7 +123,7 @@ paths:
in: path
required: true
post:
summary: ''
summary: 'Assign user to project'
operationId: post-projects-project_id-users
responses:
'200':
Expand Down
37 changes: 0 additions & 37 deletions api/openapi/apis/users.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -442,36 +442,6 @@ paths:
$ref: ../models/user/UserBase.yaml
tags:
- User
patch:
summary: Patch user
description: |-
Partially update user information.
### Authority
- `ADMINISTRATOR`
- `USER`
### Access level
- Administrator has access to any user profile
- User has access only to his profile
operationId: patch-users-user_id
responses:
'200':
$ref: '#/components/responses/Update'
'400':
description: Bad Request
'401':
description: Unauthorized
'403':
description: Forbidden
'404':
description: Not Found
requestBody:
$ref: '#/components/requestBodies/JsonPatch'
tags:
- User
delete:
summary: Delete user
operationId: delete-users-user_id
Expand Down Expand Up @@ -1069,13 +1039,6 @@ components:
application/problem+json:
schema:
$ref: ../models/Problem.yaml
requestBodies:
JsonPatch:
content:
application/json-patch+json:
schema:
$ref: ../models/PatchOperationList.yaml
description: JSON Patch operations
tags:
- name: Implemented
description: Implemented
Expand Down

0 comments on commit 8a07e50

Please sign in to comment.