WIP - Send Postman Correct ID When Getting Collection #4129
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
So this was a doozy (and I only found it by rampaging around renaming things into something
that seemed more consistent for me - see nearby commits).
Postman has two identifiers for most objects in most contexts:
- `id`: This is a unique identifier for the object, and is (at least) shaped like a UUID
- `uid`: Same as ID, except that the creating users's ID is concatenated as a prefix.
- IMPORTANT NOTE - This is NOT a UUID
Notably, the collections APIs all ask for the collection _id_ as the URL path parameter specifying
the collection you want to grab info for, _not_ the uid. This could be an ambiguity in the API
docs (maybe it accepts both? Maybe it _sometimes_ accepts both?), but it's not clear to me right now.
The naming of our variables here aren't very clear unless you're deep in the thick of it (and maybe
not even clear then). What happened here (it looks like) is that someone mistook a `uid` for something
that made sense to stuff into a "UUID"-suffixed variable.
2 tasks
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.
So this was a doozy (and I only found it by rampaging around renaming things into something that seemed more consistent for me - see nearby commits).
Postman has two identifiers for most objects in most contexts:
id: This is a unique identifier for the object, and is (at least) shaped like a UUIDuid: Same as ID, except that the creating users's ID is concatenated as a prefix. - IMPORTANT NOTE - This is NOT a UUIDNotably, the collections APIs all ask for the collection id as the URL path parameter specifying the collection you want to grab info for, not the uid. This could be an ambiguity in the API docs (maybe it accepts both? Maybe it sometimes accepts both?), but it's not clear to me right now.
The naming of our variables here aren't very clear unless you're deep in the thick of it (and maybe not even clear then). What happened here (it looks like) is that someone mistook a
uidfor something that made sense to stuff into a "UUID"-suffixed variable.Description:
Explain the purpose of the PR.
Checklist:
make test-community)?make lintthis requires golangci-lint)?