Update format for Get Profile Traits endpoint example #5066
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
rchinn1
approved these changes
Jul 26, 2023
|
Thank you for your contribution! Your pull request is merged, but may take a day or two to appear on the site. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Proposed changes
In the Profile API section on getting a Profile’s traits, the first demonstration of this endpoint is:
GET /v1/spaces/<space_id>/collections/users/profiles/<external_id>/traitsHowever, scrolling down to the examples shows:
GET /v1/spaces/lg8283283/collections/users/profiles/user_id:u1234/traitsThe format in the user_id example is
users/profiles/<id_type:ext_id>, which is the correct format, whereas the first demo of the URL is justusers/profiles/<external_id>- if only the external_id is set in the request URL without the id_type, a 404 Not Found error is returned.Scrolling further down to the first example for getting a profile’s External IDs also demonstrates the correct format:
GET /v1/spaces/<space_id>/collections/users/profiles/<id_type:ext_id>/external_idsTo better demonstrate the correct format, updated the first example for getting a Profile’s traits to be:
GET /v1/spaces/<space_id>/collections/users/profiles/<id_type:external_id>/traitsMerge timing
Related issues (optional)