Per 10309 fix api best practice violations#801
Open
liam-lloyd wants to merge 3 commits into
Open
Conversation
Currently, record objects returned from our API have a recordId field. This field should, accordingly to our API design principles, be called id to avoid stuttering. This commit adds an id field to records and marks the recordId field deprecated.
This commit adds an itemType field to the response objects from
/folder/{id}/children so callers of this endpoint can easily determine
whether any given item is a record or a folder.
liam-lloyd
force-pushed
the
per-10309_fix_api_best_practice_violations
branch
from
6776f1f to
45bd2e7
Compare
Currently, folder objects returned from our API have a folderId field. This field should, accordingly to our API design principles, be called id to avoid stuttering, and in fact it is called id in the documentation. Thus, this commit adds an id field to folders. It leaves the folderId field in place for backward compatibility (but does not add it to the documentation).
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #801 +/- ##
=======================================
Coverage 98.56% 98.56%
=======================================
Files 109 109
Lines 2783 2783
Branches 462 462
=======================================
Hits 2743 2743
Misses 36 36
Partials 4 4
Flags with carried forward coverage won't be shown. Click here to find out more. ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
This does two small changes to bring our API closer to compliance with our standards
idfield to record objects (to replace the stutteringrecordId, though that's retained for now)itemTypefield to the items returned by GET /folders/{id}/children (which isn't strictly about following the standard but will make the API more friendly to callersI'm working on other things as part of this ticket as well, but they're bigger changes so I decided to put up this PR separately.