mirror of
https://github.com/usememos/memos.git
synced 2026-11-19 10:29:11 +01:00
3.8 KiB
3.8 KiB
API Changelog
Breaking and deprecated changes to the public API in proto/api/, newest release first. Additive changes are not listed.
The Proto Linter workflow runs buf breaking against the base commit and fails when a schema break lands without an edit to
this file. It cannot see REST route changes in google.api.http annotations or behavior changes with an unchanged schema;
record those by hand.
Add entries under a ## Unreleased heading. After the release ships, rename it to the release tag.
## Unreleased
### Breaking
- `MemoService.ListShortcuts`: removed. Use `UserService.ListMemoViews`.
### Deprecated
- `Memo.unassigned`: use an unset `Memo.space`. Removed in a later release.
Unreleased
Breaking
- The API no longer carries a
v1version marker. Every client must update its paths:- REST routes move from
/api/v1/...to/api/...(for exampleGET /api/memos). Server-sent events move from/api/v1/sseto/api/sse. - The proto package
memos.api.v1is nowmemos.api, so Connect and gRPC procedures move from/memos.api.v1.<Service>/<Method>to/memos.api.<Service>/<Method>. - Resource types move from
memos.api.v1/<Type>tomemos.api/<Type>. - The
domainofgoogle.rpc.ErrorInfodetails is nowmemos.api. - For this release only, requests to
/api/v1/...and/memos.api.v1.*return410 Gonewith anUNIMPLEMENTEDerror that points here. The next release removes these routes.
- REST routes move from
- Field numbers in every message are renumbered from 1 in declaration order, and all
reservedranges are removed. JSON field names are unchanged; clients that use the binary protobuf encoding must regenerate from the new schema. - Names now follow AIP conventions:
MemoService:ListMemoAttachments,ListMemoRelations,ListMemoComments,CreateMemoComment,ListMemoReactions, andUpsertMemoReactiontakeparentinstead ofname(REST path variable{parent=memos/*}).ListMemoCommentsResponse.memosis nowcomments. The nestedMemoRelation.Memotype is nowMemoRelation.MemoRef. TheMemoShareresource singular/plural is nowmemoShare/memoShares.UserService.ListAllUserStatsis nowListUserStats. It requires aparent:users/-for all users (RESTGET /api/users/-/statsinstead ofGET /api/users:stats) orusers/{user}for one user. The response fieldstatsis nowuser_stats.BatchGetUsersRequest.usernamesis nownamesand takes resource names (users/{user}), not bare usernames.PersonalAccessToken.created_at,expires_at, andlast_used_atare nowcreate_time,expire_time, andlast_use_time.LinkedIdentity.idp_nameandextern_uidare nowidentity_providerandexternal_uid;CreateLinkedIdentityRequest.idp_nameis nowidentity_provider.- The
MemoViewandUserNotificationresource singulars are nowmemoViewanduserNotification. UserStats.tag_countis nowtag_counts.MemoImportPlan,MemoImportReport, andMemoImportIssueare nowImportMemosPlan,ImportMemosReport, andImportMemosIssue.ImportMemosPlan.memosandattachmentsare nowmemo_countandattachment_count;ImportMemosIssue.memois nowmemo_uid.UserNotification.SpaceInvitationPayload.Stateis nowInvitationState.UpdateUserSettingRequest.settingandListUserSettingsResponse.settingsare nowuser_settinganduser_settings;UpdateInstanceSettingRequest.settingandBatchGetInstanceSettingsResponse.settingsare nowinstance_settingandinstance_settings.SignInResponse.access_token_expires_atandRefreshTokenResponse.expires_atare both nowaccess_token_expire_time.SignInRequest.SSOCredentialsis nowSsoCredentials, and itsidp_nameis nowidentity_provider.