refactor(api)!: show uid instead of parent_lookup DEV-1049
#6323
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…v-1049-show-uid-instead-of-parent-lookup
RuthTurk
requested review from
Guitlle,
jnm,
magicznyleszek,
noliveleger and
rgraber
as code owners
noliveleger
requested changes
Oct 2, 2025
noliveleger
requested changes
Oct 2, 2025
There was a problem hiding this comment.
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_uidshould 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_uidtouid_paired_data /api/v2/organizations/{organization_id}/invites/, some other endpoints for organizations are using{id}. Let's useuid_organizationeverywhere if we can.
…v-1049-show-uid-instead-of-parent-lookup
noliveleger
requested changes
Oct 6, 2025
kpi/urls/router_api_v2.py
Outdated
Comment on lines
183
to
201
| # organization_routes = router_api_v2.register( | ||
| # r'organizations', | ||
| # OrganizationViewSet, | ||
| # basename='organizations', | ||
| # ) | ||
|
|
||
| # organization_routes.register( | ||
| # r'members', | ||
| # OrganizationMemberViewSet, | ||
| # basename='organization-members', | ||
| # parents_query_lookups=['organization'], | ||
| # ) | ||
|
|
||
| # organization_routes.register( | ||
| # r'invites', | ||
| # OrgMembershipInviteViewSet, | ||
| # basename='organization-invites', | ||
| # parents_query_lookups=['organization'], | ||
| # ) |
There was a problem hiding this comment.
I guess you can remove those lines ;-)
noliveleger
requested changes
Oct 6, 2025
There was a problem hiding this comment.
I found some issues:
All methods for endpoint:
- /api/v2/assets/{uid_asset}/export-settings/{uid_export_setting}/
The doc still exposes uid (for uid_export_settings)
Same case (all methods):
/api/v2/assets/{uid_asset}/exports/{uid_export}//api/v2/assets/{uid_asset}/hooks/{uid_hook}//api/v2/assets/{uid_asset}/permission-assignments/{uid_permission_assignment}/
As per our discussion,
please change /api/v2/organizations/{uid_organization}/members/{user__username}/ to /api/v2/organizations/{uid_organization}/members/{username}/
…v-1049-show-uid-instead-of-parent-lookup
…e username in the organization members api
RuthTurk
added a commit
that referenced
this pull request
Oct 9, 2025
…V-1144 (#6351) ### 📣 Summary Fix `uid` value that was missed in #6323 resulting in form previews and submission edits failures. ### 💭 Notes Also fixed the asset snapshot documentation where GET and POST to `/api/v2/asset_snapshots/` were requiring an `uid_asset_snapshot` parameter. ### 👀 Preview steps 1. ℹ️ have an account and a project 2. Click the preview button 3. 🔴 [on main] Server responds with 500 and shows error modal 4. 🟢 [on PR] Form preview works 5. 🟢 [on PR] verify that submission edits succeed 6. Checkout the documentation: `api/v2/docs` 7. 🟢 verify that GET and POST to `/api/v2/asset_snapshots/` doesn't require an `uid_asset_snapshot` parameter
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📣 Summary
Update the drf-spectacular api documentation to use a consistent
uid_<object_name>naming convention.👀 Preview steps
api/v2/docsparent_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}/