Skip to content

docs: add Memos 0.27.x API docs#263

Merged
boojack merged 1 commit intomainfrom
codex/update-api-docs-0-27
Apr 19, 2026
Merged

docs: add Memos 0.27.x API docs#263
boojack merged 1 commit intomainfrom
codex/update-api-docs-0-27

Conversation

@boojack
Copy link
Copy Markdown
Member

@boojack boojack commented Apr 19, 2026

Summary

  • add a 0.27.x API reference pinned to usememos/memos v0.27.1
  • regenerate the OpenAPI YAML and Fumadocs MDX pages
  • add AI Service navigation for the new transcription endpoint

Why

Memos released v0.27.0 and v0.27.1. Their published OpenAPI specs are identical, so the docs pin the 0.27.x line to v0.27.1 while preserving 0.26.x as the previous release line.

Validation

  • pnpm postinstall
  • pnpm lint
  • pnpm build
  • git diff --check

Summary by CodeRabbit

  • New Features

    • Added AI transcription service with new API endpoint for audio transcription.
  • Documentation

    • Comprehensive API reference documentation for version 0.27.1 released, covering all services and endpoints including AI, attachment, authentication, identity provider, instance, memo, shortcut, and user services.
    • Updated latest API documentation with new transcription service.

@coderabbitai
Copy link
Copy Markdown

coderabbitai Bot commented Apr 19, 2026

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 584423d7-4256-459c-b88e-ec23736cbba9

📥 Commits

Reviewing files that changed from the base of the PR and between 2e36aca and 02a2870.

📒 Files selected for processing (82)
  • content/docs/api/0-27-1/aiservice/Transcribe.mdx
  • content/docs/api/0-27-1/aiservice/meta.json
  • content/docs/api/0-27-1/attachmentservice/BatchDeleteAttachments.mdx
  • content/docs/api/0-27-1/attachmentservice/CreateAttachment.mdx
  • content/docs/api/0-27-1/attachmentservice/DeleteAttachment.mdx
  • content/docs/api/0-27-1/attachmentservice/GetAttachment.mdx
  • content/docs/api/0-27-1/attachmentservice/ListAttachments.mdx
  • content/docs/api/0-27-1/attachmentservice/UpdateAttachment.mdx
  • content/docs/api/0-27-1/attachmentservice/meta.json
  • content/docs/api/0-27-1/authservice/GetCurrentUser.mdx
  • content/docs/api/0-27-1/authservice/RefreshToken.mdx
  • content/docs/api/0-27-1/authservice/SignIn.mdx
  • content/docs/api/0-27-1/authservice/SignOut.mdx
  • content/docs/api/0-27-1/authservice/meta.json
  • content/docs/api/0-27-1/identityproviderservice/CreateIdentityProvider.mdx
  • content/docs/api/0-27-1/identityproviderservice/DeleteIdentityProvider.mdx
  • content/docs/api/0-27-1/identityproviderservice/GetIdentityProvider.mdx
  • content/docs/api/0-27-1/identityproviderservice/ListIdentityProviders.mdx
  • content/docs/api/0-27-1/identityproviderservice/UpdateIdentityProvider.mdx
  • content/docs/api/0-27-1/identityproviderservice/meta.json
  • content/docs/api/0-27-1/index.mdx
  • content/docs/api/0-27-1/instanceservice/GetInstanceProfile.mdx
  • content/docs/api/0-27-1/instanceservice/GetInstanceSetting.mdx
  • content/docs/api/0-27-1/instanceservice/UpdateInstanceSetting.mdx
  • content/docs/api/0-27-1/instanceservice/meta.json
  • content/docs/api/0-27-1/memoservice/CreateMemo.mdx
  • content/docs/api/0-27-1/memoservice/CreateMemoComment.mdx
  • content/docs/api/0-27-1/memoservice/CreateMemoShare.mdx
  • content/docs/api/0-27-1/memoservice/DeleteMemo.mdx
  • content/docs/api/0-27-1/memoservice/DeleteMemoReaction.mdx
  • content/docs/api/0-27-1/memoservice/DeleteMemoShare.mdx
  • content/docs/api/0-27-1/memoservice/GetMemo.mdx
  • content/docs/api/0-27-1/memoservice/GetMemoByShare.mdx
  • content/docs/api/0-27-1/memoservice/ListMemoAttachments.mdx
  • content/docs/api/0-27-1/memoservice/ListMemoComments.mdx
  • content/docs/api/0-27-1/memoservice/ListMemoReactions.mdx
  • content/docs/api/0-27-1/memoservice/ListMemoRelations.mdx
  • content/docs/api/0-27-1/memoservice/ListMemoShares.mdx
  • content/docs/api/0-27-1/memoservice/ListMemos.mdx
  • content/docs/api/0-27-1/memoservice/SetMemoAttachments.mdx
  • content/docs/api/0-27-1/memoservice/SetMemoRelations.mdx
  • content/docs/api/0-27-1/memoservice/UpdateMemo.mdx
  • content/docs/api/0-27-1/memoservice/UpsertMemoReaction.mdx
  • content/docs/api/0-27-1/memoservice/meta.json
  • content/docs/api/0-27-1/meta.json
  • content/docs/api/0-27-1/shortcutservice/CreateShortcut.mdx
  • content/docs/api/0-27-1/shortcutservice/DeleteShortcut.mdx
  • content/docs/api/0-27-1/shortcutservice/GetShortcut.mdx
  • content/docs/api/0-27-1/shortcutservice/ListShortcuts.mdx
  • content/docs/api/0-27-1/shortcutservice/UpdateShortcut.mdx
  • content/docs/api/0-27-1/shortcutservice/meta.json
  • content/docs/api/0-27-1/userservice/BatchGetUsers.mdx
  • content/docs/api/0-27-1/userservice/CreatePersonalAccessToken.mdx
  • content/docs/api/0-27-1/userservice/CreateUser.mdx
  • content/docs/api/0-27-1/userservice/CreateUserWebhook.mdx
  • content/docs/api/0-27-1/userservice/DeletePersonalAccessToken.mdx
  • content/docs/api/0-27-1/userservice/DeleteUser.mdx
  • content/docs/api/0-27-1/userservice/DeleteUserNotification.mdx
  • content/docs/api/0-27-1/userservice/DeleteUserWebhook.mdx
  • content/docs/api/0-27-1/userservice/GetUser.mdx
  • content/docs/api/0-27-1/userservice/GetUserSetting.mdx
  • content/docs/api/0-27-1/userservice/GetUserStats.mdx
  • content/docs/api/0-27-1/userservice/ListAllUserStats.mdx
  • content/docs/api/0-27-1/userservice/ListPersonalAccessTokens.mdx
  • content/docs/api/0-27-1/userservice/ListUserNotifications.mdx
  • content/docs/api/0-27-1/userservice/ListUserSettings.mdx
  • content/docs/api/0-27-1/userservice/ListUserWebhooks.mdx
  • content/docs/api/0-27-1/userservice/ListUsers.mdx
  • content/docs/api/0-27-1/userservice/UpdateUser.mdx
  • content/docs/api/0-27-1/userservice/UpdateUserNotification.mdx
  • content/docs/api/0-27-1/userservice/UpdateUserSetting.mdx
  • content/docs/api/0-27-1/userservice/UpdateUserWebhook.mdx
  • content/docs/api/0-27-1/userservice/meta.json
  • content/docs/api/latest/aiservice/Transcribe.mdx
  • content/docs/api/latest/aiservice/meta.json
  • content/docs/api/latest/index.mdx
  • content/docs/api/latest/meta.json
  • content/docs/api/meta.json
  • openapi/0-27-1.yaml
  • openapi/latest.yaml
  • scripts/generate-openapi.mjs
  • src/lib/api-docs-versions.json

📝 Walkthrough

Walkthrough

This PR adds comprehensive API documentation for version 0.27.1, including pages for eight service categories (AI, Attachment, Auth, Identity Provider, Instance, Memo, Shortcut, and User services). It also introduces AI Service documentation to the latest version and updates the OpenAPI specification with new transcription endpoint definitions and schema components.

Changes

Cohort / File(s) Summary
0.27.1 AI Service Documentation
content/docs/api/0-27-1/aiservice/Transcribe.mdx, content/docs/api/0-27-1/aiservice/meta.json
Added Transcribe endpoint documentation page and service metadata defining "AI Service" with one included page.
0.27.1 Attachment Service Documentation
content/docs/api/0-27-1/attachmentservice/BatchDeleteAttachments.mdx, CreateAttachment.mdx, DeleteAttachment.mdx, GetAttachment.mdx, ListAttachments.mdx, UpdateAttachment.mdx, meta.json
Added six API operation pages (batch delete, create, delete, get, list, update) and service metadata for "Attachment Service".
0.27.1 Auth Service Documentation
content/docs/api/0-27-1/authservice/GetCurrentUser.mdx, RefreshToken.mdx, SignIn.mdx, SignOut.mdx, meta.json
Added four authentication operation pages (get current user, refresh token, sign in, sign out) and service metadata for "Auth Service".
0.27.1 Identity Provider Service Documentation
content/docs/api/0-27-1/identityproviderservice/CreateIdentityProvider.mdx, DeleteIdentityProvider.mdx, GetIdentityProvider.mdx, ListIdentityProviders.mdx, UpdateIdentityProvider.mdx, meta.json
Added five identity provider operation pages (create, delete, get, list, update) and service metadata for "Identity Provider Service".
0.27.1 Instance Service Documentation
content/docs/api/0-27-1/instanceservice/GetInstanceProfile.mdx, GetInstanceSetting.mdx, UpdateInstanceSetting.mdx, meta.json
Added three instance operation pages (get profile, get setting, update setting) and service metadata for "Instance Service".
0.27.1 Memo Service Documentation
content/docs/api/0-27-1/memoservice/CreateMemo.mdx, CreateMemoComment.mdx, CreateMemoShare.mdx, DeleteMemo.mdx, DeleteMemoReaction.mdx, DeleteMemoShare.mdx, GetMemo.mdx, GetMemoByShare.mdx, ListMemoAttachments.mdx, ListMemoComments.mdx, ListMemoReactions.mdx, ListMemoRelations.mdx, ListMemoShares.mdx, ListMemos.mdx, SetMemoAttachments.mdx, SetMemoRelations.mdx, UpdateMemo.mdx, UpsertMemoReaction.mdx, meta.json
Added 18 memo operation pages covering creation, deletion, updates, relations, comments, reactions, shares, and attachments, plus service metadata for "Memo Service".
0.27.1 Shortcut Service Documentation
content/docs/api/0-27-1/shortcutservice/CreateShortcut.mdx, DeleteShortcut.mdx, GetShortcut.mdx, ListShortcuts.mdx, UpdateShortcut.mdx, meta.json
Added five shortcut operation pages (create, delete, get, list, update) and service metadata for "Shortcut Service".
0.27.1 User Service Documentation
content/docs/api/0-27-1/userservice/BatchGetUsers.mdx, CreatePersonalAccessToken.mdx, CreateUser.mdx, CreateUserWebhook.mdx, DeletePersonalAccessToken.mdx, DeleteUser.mdx, DeleteUserNotification.mdx, DeleteUserWebhook.mdx, GetUser.mdx, GetUserSetting.mdx, GetUserStats.mdx, ListAllUserStats.mdx, ListPersonalAccessTokens.mdx, ListUserNotifications.mdx, ListUserSettings.mdx, ListUserWebhooks.mdx, ListUsers.mdx, UpdateUser.mdx, UpdateUserNotification.mdx, UpdateUserSetting.mdx, UpdateUserWebhook.mdx, meta.json
Added 21 user-related operation pages covering user management, personal access tokens, webhooks, notifications, and settings, plus service metadata for "User Service".
0.27.1 Version Setup
content/docs/api/0-27-1/index.mdx, content/docs/api/0-27-1/meta.json
Added root API reference page documenting authentication, pagination, filtering, update masks, and error handling for 0.27.x release; added version metadata listing all eight service categories.
Latest Version & API Registry
content/docs/api/latest/aiservice/Transcribe.mdx, content/docs/api/latest/aiservice/meta.json, content/docs/api/latest/index.mdx, content/docs/api/latest/meta.json, content/docs/api/meta.json, src/lib/api-docs-versions.json
Added AI Service documentation to latest version; updated navigation and version metadata files to include new 0.27.1 version with label "0.27.x".
OpenAPI Specification & Build Scripts
openapi/latest.yaml, scripts/generate-openapi.mjs
Extended OpenAPI spec with new POST /api/v1/ai:transcribe endpoint for AIService, added TranscribeRequest/TranscribeResponse/TranscriptionAudio/TranscriptionConfig schemas, extended InstanceSetting with aiSetting field and AI provider configuration schemas; updated script to register "AI Service" and "Transcribe" entry page in generation mappings.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~12 minutes

Poem

🐰 Hops through docs with joy and care,
New endpoints floating in the air,
AI transcribes, users connect,
Every service gets respect!
0-27-1 shines bright,
Documentation done just right!

✨ 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 codex/update-api-docs-0-27

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 and usage tips.

@boojack boojack marked this pull request as ready for review April 19, 2026 06:43
@boojack boojack changed the title [codex] Add Memos 0.27.x API docs docs: add Memos 0.27.x API docs Apr 19, 2026
@boojack boojack merged commit 1854aaf into main Apr 19, 2026
4 of 5 checks passed
@boojack boojack deleted the codex/update-api-docs-0-27 branch April 19, 2026 06:44
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.

2 participants