Skip to content

Conversation

Pager07
Copy link
Contributor

@Pager07 Pager07 commented Apr 8, 2025

Under the Creating/Updating Users section , this PR has added the docs on how to add photo to roles.

@Pager07 Pager07 assigned Pager07 and DanJezeph15 and unassigned Pager07 Apr 8, 2025
Copy link
Contributor

@DanJezeph15 DanJezeph15 left a 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

@DanJezeph15 DanJezeph15 assigned Pager07 and unassigned DanJezeph15 Apr 9, 2025
@Pager07 Pager07 assigned DanJezeph15 and unassigned Pager07 Apr 9, 2025
@Pager07
Copy link
Contributor Author

Pager07 commented Apr 9, 2025

  • 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.

Copy link
Contributor

@DanJezeph15 DanJezeph15 left a 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.
Copy link
Contributor

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.

Copy link
Contributor

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

@DanJezeph15 DanJezeph15 assigned Pager07 and unassigned DanJezeph15 Apr 10, 2025
@Pager07 Pager07 assigned DanJezeph15 and unassigned Pager07 Apr 10, 2025
name: photo
type: string
description: URL to access the Contractor's profile photo.
description: URL to access the user's profile photo.
Copy link
Contributor

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

@HenryTraill HenryTraill assigned Pager07 and unassigned HenryTraill Apr 10, 2025
@Pager07 Pager07 assigned HenryTraill and unassigned Pager07 Apr 10, 2025
@HenryTraill HenryTraill merged commit 0ab855f into master Apr 10, 2025
4 checks passed
@HenryTraill HenryTraill deleted the roles-profile-pic-doc branch April 10, 2025 16:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants