SUPP-144: Disambiguate Try It endpoint names for profile APIs#15
SUPP-144: Disambiguate Try It endpoint names for profile APIs#15myronkaifung with Copilot wants to merge 2 commits into
Conversation
SUPP-144 Suggestion: Add more specific name to API endpoints
Type: Suggestion · Fix before launch: Yes · Reporter: Myron Fung Suggestion summary Migrated from Notion · source entry |
Confidence Score: 3/5Not safe to merge as-is — the two union endpoint titles are swapped, which would actively mislead users in the dropdown. The union endpoints in group-union.mdx and user-profile-union.mdx ended up with each other's qualifiers, so merging would make the dropdown worse for those two entries than before the PR. The remaining 8 renames are correct. reference/group-union.mdx and reference/user-profile-union.mdx need their titles swapped.
|
| Filename | Overview |
|---|---|
| reference/group-union.mdx | Title incorrectly says "User Profile" for a group-profile endpoint — swapped with user-profile-union.mdx |
| reference/user-profile-union.mdx | Title incorrectly says "Group Profile" for a user-profile endpoint — swapped with group-union.mdx |
| reference/group-delete-property.mdx | Title updated to "Delete Group Profile Property" — correct and consistent |
| reference/group-set-property.mdx | Title updated to "Update Group Profile Property" — correct |
| reference/profile-set.mdx | Title updated to "Set User Profile Property" — correct |
Flowchart
%%{init: {'theme': 'neutral'}}%%
flowchart TD
A[Try It Dropdown] --> B[User Profile Endpoints]
A --> C[Group Profile Endpoints]
B --> B1["Set User Profile Property ✅"]
B --> B2["Set User Profile Property Once ✅"]
B --> B3["Delete User Profile Property ✅"]
B --> B4["Remove from User Profile List Property ✅"]
B --> B5["Union to Group Profile List Property ❌\n(user-profile-union.mdx — wrong label)"]
C --> C1["Update Group Profile Property ✅"]
C --> C2["Set Group Profile Property Once ✅"]
C --> C3["Delete Group Profile Property ✅"]
C --> C4["Remove from Group Profile List Property ✅"]
C --> C5["Union to User Profile List Property ❌\n(group-union.mdx — wrong label)"]
Reviews (1): Last reviewed commit: "SUPP-144 clarify API endpoint titles in ..." | Re-trigger Greptile
| --- | ||
| openapi: /openapi/ingestion.openapi.yaml POST /groups#group-union | ||
| title: Union To List Property | ||
| title: Union to User Profile List Property |
There was a problem hiding this comment.
Titles swapped between group and user union endpoints
group-union.mdx was given the title Union to User Profile List Property, while user-profile-union.mdx was given Union to Group Profile List Property — the qualifiers are inverted. The group endpoint should read "Group Profile" and the user endpoint should read "User Profile", not the other way around. As-is, the dropdown will show each endpoint under the wrong context, which is exactly the problem the PR was meant to fix.
| --- | ||
| openapi: /openapi/ingestion.openapi.yaml POST /engage#profile-union | ||
| title: Union To List Property | ||
| title: Union to Group Profile List Property |
There was a problem hiding this comment.
Title incorrectly labels user profile union as a group profile endpoint
This file (user-profile-union.mdx) maps to POST /engage#profile-union — a user profile operation — but its new title is Union to Group Profile List Property. It should be Union to User Profile List Property. The title in group-union.mdx has the same problem in reverse; both appear to have been swapped.
The Try It endpoint switcher showed ambiguous duplicate names (for example, multiple “Update Property” entries) without sidebar context. This change makes profile-related endpoint labels explicit so users can distinguish user-profile vs group-profile operations at a glance.
What changed
User ProfileorGroup Profile).Where
reference/profile-*.mdxreference/group-*.mdxreference/user-profile-union.mdxExample
Original prompt