Skip to content

SUPP-144: Disambiguate Try It endpoint names for profile APIs#15

Draft
myronkaifung with Copilot wants to merge 2 commits into
mainfrom
copilot/supp-144-add-specific-names-api-endpoints
Draft

SUPP-144: Disambiguate Try It endpoint names for profile APIs#15
myronkaifung with Copilot wants to merge 2 commits into
mainfrom
copilot/supp-144-add-specific-names-api-endpoints

Conversation

Copilot AI commented Jun 9, 2026

Copy link
Copy Markdown

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

    • Updated reference page frontmatter titles for overlapping profile operations to include scope (User Profile or Group Profile).
    • Applied to the duplicated operation families: set/update, set once, delete/unset, remove-from-list, and union.
  • Where

    • reference/profile-*.mdx
    • reference/group-*.mdx
    • reference/user-profile-union.mdx
  • Example

    ---
    openapi: /openapi/ingestion.openapi.yaml POST /groups#group-set
    title: Update Group Profile Property
    ---
Original prompt
<title>Suggestion: Add more specific name to API endpoints</title> **Type:** Suggestion · **Fix before launch:** Yes · **Reporter:** Myron Fung

Suggestion summary
When you open the Try It module in the API, clicking on the top-left dropdown shows all of the other API endpoints you can switch to. However, there are many duplicate names since the dropdown does not have context of the subsection. For example, there are 2 options for "Update Property" — one is for group profile while the other is for user profile, but that is not obvious from the Try It module dropdown without the sidebar organizational context.


Migrated from Notion · source entry


Fix before launch

Only assign incident/ labels when asked to by a user. incident/ labels are reserved for customer facing incidents.
Fixes https://linear.app/mixpanel/issue/SUPP-144/suggestion-add-more-specific-name-to-api-endpoints

Branch naming

This task relates to issue SUPP-144 — preserve that identifier somewhere in the branch name and pull request title for traceability. Do not treat the identifier as a verbatim slug or prepend it with a hyphen by default; instead, adapt the full branch name to comply with the repository's branch-naming pattern, adding any required prefix or restructuring the shape as needed.

Include a link to the original issue in the pull request description: https://linear.app/mixpanel/issue/SUPP-144/suggestion-add-more-specific-name-to-api-endpoints

@linear-code

linear-code Bot commented Jun 9, 2026

Copy link
Copy Markdown
SUPP-144 Suggestion: Add more specific name to API endpoints

Type: Suggestion · Fix before launch: Yes · Reporter: Myron Fung

Suggestion summary
When you open the Try It module in the API, clicking on the top-left dropdown shows all of the other API endpoints you can switch to. However, there are many duplicate names since the dropdown does not have context of the subsection. For example, there are 2 options for "Update Property" — one is for group profile while the other is for user profile, but that is not obvious from the Try It module dropdown without the sidebar organizational context.


Migrated from Notion · source entry

Review in Linear · Agent session

Copilot AI changed the title [WIP] Add more specific names to API endpoints SUPP-144: Disambiguate Try It endpoint names for profile APIs Jun 9, 2026
Copilot AI requested a review from myronkaifung June 9, 2026 21:42
@greptile-apps

greptile-apps Bot commented Jun 9, 2026

Copy link
Copy Markdown

Confidence Score: 3/5

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

Important Files Changed

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)"]
Loading

Reviews (1): Last reviewed commit: "SUPP-144 clarify API endpoint titles in ..." | Re-trigger Greptile

Comment thread reference/group-union.mdx
---
openapi: /openapi/ingestion.openapi.yaml POST /groups#group-union
title: Union To List Property
title: Union to User Profile List Property

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 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

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

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.

2 participants