owncloud / owncloud/libre-graph-api
Missleading 'members@odata.bind` property on group and educationClass
Nobody has claimed this yet.
- Dominant language
- Mustache
- Stars
- 4
- Forks
- 3
- Avg merge
- 23h 14m
- Merged PRs (30d)
- 1
Description
Our definition of the group and educationClass resources contain a somewhat missleading members@odata.bind property (see e.g. https://github.com/owncloud/libre-graph-api/blob/main/api/openapi-spec/v1.0.yaml#L2245).
This is not really a property and cause confusion when showing up that way in the swagger ui. The @odata.bind is actually just an annotation that can be used in POST/PATCH request to manage relations between resources.
I am not sure yet whether our tooling allows to specify this in a better manner, but we should investigate this to avoid confusion.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start in api/openapi-spec/v1.0.yaml around line 2245 and inspect the group and educationClass definitions shown in Swagger UI. Investigate how the schema tooling represents members@odata.bind, then verify that it is no longer presented as a regular property while relation management remains described correctly.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- openapi
- Domain
- api
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 42/100