docs(doc): clarify history edit time format - #1962
Conversation
📝 WalkthroughWalkthroughThe lark-doc history reference and execution test define and validate ChangesHistory timestamp contract
Estimated code review effort: 1 (Trivial) | ~2 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
🚀 PR Preview Install Guide🧰 CLI updatenpm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@1fd150f11277ec054095508e093ea141603fa003🧩 Skill updatenpx skills add larksuite/cli#fix/docs-history-edit-time-format -y -g |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1962 +/- ##
==========================================
- Coverage 76.35% 76.34% -0.01%
==========================================
Files 991 991
Lines 106029 106029
==========================================
- Hits 80954 80952 -2
- Misses 18941 18942 +1
- Partials 6134 6135 +1 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
048ef51 to
86a12f8
Compare
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
86a12f8 to
bf6ad03
Compare
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
bf6ad03 to
1fd150f
Compare
|
Note GitHub couldn't provide a complete incremental comparison for this pull request, so CodeRabbit is performing a full review instead. This review may take a little longer. |
Summary
Clarify the actual
edit_timewire format returned by the Docs history OpenAPI so time-based history selection does not rely on the stale Unix timestamp example.The CLI does not normalize this field:
DocsHistoryList.Executereturns the successful APIdataobject throughOutRawunchanged. The documentation and execution test should therefore match the upstream RFC3339 wire value.Changes
entries[].edit_timeas an RFC3339 string.DocsHistoryListresponse fixture with the wire format and assert that the CLI preservesedit_timeunchanged.Test Plan
git diff --check origin/main...HEADgo test ./shortcuts/doc -run '^TestDocsHistoryExecuteList$' -count=1node scripts/skill-format-check/index.jsCallAPITypedreturns the successful responsedataobject untouched andDocsHistoryList.Executeemits it throughOutRaw.ai_editOpenAPI layer formatsedit_timewithtime.RFC3339and a livedocs +history-listresponse returns RFC3339.Related Issues
Summary by CodeRabbit