Skip to content

docs(doc): clarify history edit time format - #1962

Merged
fangshuyu-768 merged 1 commit into
mainfrom
fix/docs-history-edit-time-format
Aug 7, 2026
Merged

docs(doc): clarify history edit time format#1962
fangshuyu-768 merged 1 commit into
mainfrom
fix/docs-history-edit-time-format

Conversation

@liuxin-0319

@liuxin-0319 liuxin-0319 commented Jul 20, 2026

Copy link
Copy Markdown
Collaborator

Summary

Clarify the actual edit_time wire 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.Execute returns the successful API data object through OutRaw unchanged. The documentation and execution test should therefore match the upstream RFC3339 wire value.

Changes

  • Document entries[].edit_time as an RFC3339 string.
  • Update the history-list response example to use RFC3339.
  • Align the DocsHistoryList response fixture with the wire format and assert that the CLI preserves edit_time unchanged.

Test Plan

  • git diff --check origin/main...HEAD
  • go test ./shortcuts/doc -run '^TestDocsHistoryExecuteList$' -count=1
  • node scripts/skill-format-check/index.js
  • Confirmed CallAPITyped returns the successful response data object untouched and DocsHistoryList.Execute emits it through OutRaw.
  • Confirmed the upstream ai_edit OpenAPI layer formats edit_time with time.RFC3339 and a live docs +history-list response returns RFC3339.

Related Issues

  • None

Summary by CodeRabbit

  • Documentation
    • Clarified that history edit times use RFC3339 UTC timestamp strings.
    • Updated the example response to show the correct timestamp format.
    • Added guidance to parse timestamps before comparing them.
    • Updated the history example to reflect the format returned by the history list.

@github-actions github-actions Bot added domain/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact labels Jul 20, 2026
@coderabbitai

coderabbitai Bot commented Jul 20, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The lark-doc history reference and execution test define and validate entries[].edit_time as an RFC3339 UTC string.

Changes

History timestamp contract

Layer / File(s) Summary
Timestamp format and example
skills/lark-doc/references/lark-doc-history.md
Defines edit_time as an RFC3339 UTC string, requires parsing before comparisons, and updates the example response.
Timestamp fixture and execution validation
shortcuts/doc/docs_history_test.go
Updates the history fixture and verifies the decoded entry and preserved RFC3339 timestamp.

Estimated code review effort: 1 (Trivial) | ~2 minutes

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The title clearly and concisely describes the documentation change to the history edit time format.
Description check ✅ Passed The description includes the required Summary, Changes, Test Plan, and Related Issues sections with relevant details and verification steps.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix/docs-history-edit-time-format

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@github-actions

github-actions Bot commented Jul 20, 2026

Copy link
Copy Markdown

🚀 PR Preview Install Guide

🧰 CLI update

npm i -g https://pkg.pr.new/larksuite/cli/@larksuite/cli@1fd150f11277ec054095508e093ea141603fa003

🧩 Skill update

npx skills add larksuite/cli#fix/docs-history-edit-time-format -y -g

@codecov

codecov Bot commented Jul 20, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.34%. Comparing base (6402080) to head (1fd150f).

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@liuxin-0319
liuxin-0319 force-pushed the fix/docs-history-edit-time-format branch from 048ef51 to 86a12f8 Compare August 7, 2026 07:14
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

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.

@liuxin-0319
liuxin-0319 force-pushed the fix/docs-history-edit-time-format branch from 86a12f8 to bf6ad03 Compare August 7, 2026 07:17
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

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.

@liuxin-0319
liuxin-0319 force-pushed the fix/docs-history-edit-time-format branch from bf6ad03 to 1fd150f Compare August 7, 2026 07:22
@coderabbitai

coderabbitai Bot commented Aug 7, 2026

Copy link
Copy Markdown

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.

@fangshuyu-768
fangshuyu-768 merged commit 4ff2bd1 into main Aug 7, 2026
30 checks passed
@fangshuyu-768
fangshuyu-768 deleted the fix/docs-history-edit-time-format branch August 7, 2026 07:43
@liangshuo-1 liangshuo-1 mentioned this pull request Aug 7, 2026
3 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

domain/ccm PR touches the ccm domain size/M Single-domain feat or fix with limited business impact

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants