Skip to content

feat: support full v1 API through API client - #119

Draft
EastSun5566 wants to merge 2 commits into
developfrom
feature/dev-3171
Draft

EastSun5566 wants to merge 2 commits into
developfrom
feature/dev-3171

Conversation

@EastSun5566

@EastSun5566 EastSun5566 commented Sep 25, 2026 •

Copy link
Copy Markdown
Contributor

Summary

Keep convenient commands for common workflows, and add a generic api entry for full v1 coverage. Design background and references are in #118.

  • Add api operations, api describe, and api call for generated v1 operations, delegated to @hackmd/api/raw.
  • Add personal/team note descriptions on create/update, --root placement, and consistent --clear=description flags. Folders also support clearing icon and color.
  • Add single team-note lookup with --noteId and history --limit. Preserve omitted fields and reject conflicting flags before sending requests.
  • Update the README and packaged CLI skill.

Example

hackmd-cli notes --noteId=abc
hackmd-cli api describe GetNote
hackmd-cli api call GetNote --path noteId=abc

Verification

Against the linked API client from #62: build, lint, 37 unit tests, 17 localhost integration tests, and 26 smoke tests passed. Two existing unit tests remain pending. Smoke tests now explicitly run the compiled CLI in production mode.

Before merge

Depends on API client PR #62. Publish the updated API client, then pin that version in the CLI. The current 2.6.0 dependency does not support these APIs, so clean-install CI remains blocked.

Closes #118

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Support the full v1 API through the generated API client

1 participant