Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[#41299] Updated API spec for placeholder users #14769

Merged

Conversation

Kharonus
Copy link
Member

#41299

WAT??

  • added inheritance hirarchy for principal resource models
  • added placeholder user paths
  • revisited other principal specifications

Thoughts and stuff

Hey guys, the PR is rather big, with a lot of text. The reason for that is, that placeholder users were not documented at all, yet. And also affect the documentation about users and groups.

I hope, the changes are understandable, yet, there are some open questions:

  • there is a group filter for placeholder users, and apparently I can even add it to a group via API. But I wasn't able to do so via UI. What is our intention here?
  • There is an internal status set for placeholder users. Yet, it is never returned by the API, leading to a weird situation, that when you delete placeholder users you still get the data in the collection response. You cannot see a difference, as the status is not rendered.

- https://community.openproject.org/wp/41299
- added inheritance hirarchy for principal resource models
- added placeholder user paths
- revisited other principal specifications
- also fixed some older rubocop issues
@Kharonus Kharonus force-pushed the bug/41299-placeholderuser-resource-not-described-in-the-api-spec branch from 92775e2 to d3edd15 Compare February 19, 2024 09:52
- changed HTTP code back to 202 (deletion in progress)
- pin type enum
- amend representer rendering spec
@Kharonus
Copy link
Member Author

there is a group filter for placeholder users, and apparently I can even add it to a group via API. But I wasn't able to do so via UI. What is our intention here?

it is not possible to add placeholder users to a group via API or UI. The filters are probably superfluous, but I didn't remove them in this PR.

there is a group filter for placeholder users, and apparently I can even add it to a group via API. But I wasn't able to do so via UI. What is our intention here?

I added the status property to the model of placeholder users in the the API response.

@Kharonus Kharonus requested a review from apfohl February 22, 2024 08:44
Copy link
Member

@apfohl apfohl left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Very good work. 👍

@Kharonus Kharonus merged commit 4f57eb6 into dev Feb 23, 2024
11 checks passed
@Kharonus Kharonus deleted the bug/41299-placeholderuser-resource-not-described-in-the-api-spec branch February 23, 2024 08:59
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

Successfully merging this pull request may close these issues.

2 participants