Expose the yanked field on the API
#9817
Conversation
The `yanked` state is based on the `default_version`. The `default_version` can only be yanked if all other versions are also yanked. A crate should only be yanked if all of its versions are yanked.
src/views.rs
Outdated
| pub downloads: i64, | ||
| pub recent_downloads: Option<i64>, | ||
| pub default_version: Option<String>, | ||
| pub yanked: Option<bool>, |
There was a problem hiding this comment.
Should this field always be serialized as a bool, with a default value of true?
There was a problem hiding this comment.
I think I'd rather default it to false actually 😅
There was a problem hiding this comment.
I'm also fine with false as the default value. I don't have a strong preference for the default value, as a yanked state of None most likely means that the default_version is also None, which shouldn't occur in our case.
There was a problem hiding this comment.
I made the change in a new commit, which should be easier to inspect and could also be squashed before merging.
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #9817 +/- ##
==========================================
- Coverage 88.83% 88.83% -0.01%
==========================================
Files 289 289
Lines 29852 30020 +168
==========================================
+ Hits 26519 26668 +149
- Misses 3333 3352 +19 ☔ View full report in Codecov by Sentry. |
Turbo87
added
C-enhancement ✨
2 participants
This PR expose the
yankedfield on the API. Theyankedstate is based on thedefault_version. Thedefault_versioncan only be yanked if all other versions are also yanked and a crate should only be yanked if all of its versions are yanked.