Skip to content

Conversation

RuthTurk
Copy link
Member

@RuthTurk RuthTurk commented Oct 2, 2025

🗒️ Checklist

  1. run linter locally
  2. update developer docs (API, README, inline, etc.), if any
  3. for user-facing doc changes create a Zulip thread at #Support Docs Updates, if any
  4. draft PR with a title <type>(<scope>)<!>: <title> DEV-1234
  5. assign yourself, tag PR: at least Front end and/or Back end or workflow
  6. fill in the template below and delete template comments
  7. review thyself: read the diff and repro the preview as written
  8. open PR & confirm that CI passes & request reviewers, if needed
  9. delete this section before merging

📣 Summary

Update the drf-spectacular api documentation to use a consistent uid_<object_name> naming convention.

👀 Preview steps

  1. ℹ️ checkout api/v2/docs
  2. 🟢 [on PR] make sure that all parent_lookup_ have been changed to uid_ 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}/
  3. Test the endpoints to make sure they are still working

@RuthTurk RuthTurk self-assigned this Oct 2, 2025
@RuthTurk RuthTurk added the API Changes related to API endpoints label Oct 2, 2025
Copy link
Contributor

@noliveleger noliveleger left a 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 = {

Copy link
Contributor

@noliveleger noliveleger left a 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 only uid_invite
  • /api/v2/assets/{uid_asset}/data/{uid_data}/attachments/ . The documentation (inside the markdown) still refers to parent_lookup_data.
  • /api/v2/assets/{uid_asset}/paired-data/{paired_data_uid}/ . For consistency, It would also change paired_data_uid to uid_paired_data
  • /api/v2/organizations/{organization_id}/invites/, some other endpoints for organizations are using {id}. Let's use uid_organization everywhere if we can.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
API Changes related to API endpoints
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants