Skip to content
This repository has been archived by the owner on Jun 14, 2024. It is now read-only.

feat: migrate /api/users endpoint to /api/v1/users #142

Merged

Conversation

jfcalvo
Copy link
Member

@jfcalvo jfcalvo commented May 6, 2024

Description

This PR add a new endpoint GET /api/v1/users returning a list of users if the current user is an owner.

Changes of the new endpoint compared to the old one:

  • The returned object is different, in the old endpoint an array with the users is returned. In the new endpoint an object of the type {"items": [...]} is used.
  • The returned users as with previous PRs is not including the workspaces attribute and full_name has been removed as well.

Closes #141

Type of change

(Please delete options that are not relevant. Remember to title the PR according to the type of change)

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as expected)
  • Refactor (change restructuring the codebase without changing functionality)
  • Improvement (change adding some improvement to an existing functionality)
  • Documentation update

How Has This Been Tested

(Please describe the tests that you ran to verify your changes. And ideally, reference tests)

  • Adding new tests.

Checklist

  • I added relevant documentation
  • follows the style guidelines of this project
  • I did a self-review of my code
  • I made corresponding changes to the documentation
  • My changes generate no new warnings
  • I have added tests that prove my fix is effective or that my feature works
  • I filled out the contributor form (see text above)
  • I have added relevant notes to the CHANGELOG.md file (See https://keepachangelog.com/)

@jfcalvo jfcalvo requested a review from frascuchon May 6, 2024 16:14
@jfcalvo jfcalvo linked an issue May 6, 2024 that may be closed by this pull request
@jfcalvo jfcalvo changed the title feat: migrate /users endpoint to /api/v1/users feat: migrate /api/users endpoint to /api/v1/users May 7, 2024
Base automatically changed from feat/migrate-me-endpoint-to-api-v1-me to feat/move-api-v0-functionality-to-v1 May 7, 2024 14:25
@frascuchon frascuchon self-requested a review May 10, 2024 11:22
@jfcalvo jfcalvo merged commit d27a381 into feat/move-api-v0-functionality-to-v1 May 13, 2024
12 checks passed
@jfcalvo jfcalvo deleted the feat/migrate-list-users-to-api-v1 branch May 13, 2024 08:56
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[TASK] Migrate /api/users endpoint to /api/v1/users
2 participants