-
-
Notifications
You must be signed in to change notification settings - Fork 202
refactor(api)!: show uid
instead of parent_lookup
DEV-1049
#6323
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
base: release/2.025.37
Are you sure you want to change the base?
refactor(api)!: show uid
instead of parent_lookup
DEV-1049
#6323
Conversation
…v-1049-show-uid-instead-of-parent-lookup
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.
You may need to update the mapping in here
urls_pattern_mapping = { |
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.
First of all, congrats to have tackling this. It was indeed more complex than expected.
I found few tiny mistakes though 😇
/api/v2/project-ownership/invites/{uid_invite_uid}/transfers/{uid_transfer}/
uid_invite_uid
should be onlyuid_invite
/api/v2/assets/{uid_asset}/data/{uid_data}/attachments/
. The documentation (inside the markdown) still refers toparent_lookup_data
.- /api/v2/assets/{uid_asset}/paired-data/{paired_data_uid}/ . For consistency, It would also change
paired_data_uid
touid_paired_data
/api/v2/organizations/{organization_id}/invites/
, some other endpoints for organizations are using{id}
. Let's useuid_organization
everywhere if we can.
…v-1049-show-uid-instead-of-parent-lookup
🗒️ Checklist
#Support Docs Updates
, if any<type>(<scope>)<!>: <title> DEV-1234
Front end
and/orBack end
orworkflow
📣 Summary
Update the drf-spectacular api documentation to use a consistent
uid_<object_name>
naming convention.👀 Preview steps
api/v2/docs
parent_lookup_
have been changed touid_
and that all nested uids are correct.Example:
/api/v2/assets/{parent_lookup_asset}/hooks/{parent_lookup_hook}/logs/{uid}/
Should be
/api/v2/assets/{uid_asset}/hooks/{uid_hook}/logs/{uid_log}/