-
Notifications
You must be signed in to change notification settings - Fork 0
Added docs adding profile photos to roles #197
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
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
- I think we need this on each role too, so each role that can have their photo changed (I'm guessing it's all of them) should have under their attributes the photo field and also that should be updated in the right hand side example. We need this in the V1 examples and the V2 examples annoyingly
After double checking, can confirm v1 doesn't have photo field. To compensate this I have added docs to the 'Role Versioning' sections. So leaving v1 as it for now. However, do let me know if otherwise, can just chuck it in. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Else lgtm!
name: photo | ||
type: string | ||
description: URL to access the Contractor's profile photo. | ||
description: URL to access the user's profile photo. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Why this change? I think this should say contractor especially as we're moving to V2 of the API without the user stuff.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This endpoint is irrelevant afaik so just leave it as it was
name: photo | ||
type: string | ||
description: URL to access the Contractor's profile photo. | ||
description: URL to access the user's profile photo. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This endpoint is irrelevant afaik so just leave it as it was
Under the
Creating/Updating Users
section , this PR has added the docs on how to add photo to roles.