Hacktoberfest 2026:维护者为十月标记出来的 issue,仍然开放、适合新手。 浏览 Hacktoberfest issue

Document optimistic concurrency: _metadata.version, ETag, If-Match → 412 (bundle #561)

已关闭 适合新手
#297 0 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
2/5
预计耗时
1-3 小时
新手友好度
73/100
Issue 类型
文档
描述清晰度
描述清楚
活跃度
活跃
领域
documentation

调研方向

阅读现有的组件和页面数据 API 文档,然后根据本 issue 中列出的行为,确定并发和升级指南应放在哪里。记录 _metadata.version、ETag 和 If-Match 的行为、412 的情况、迁移命令以及 CORS 要求;当 API 文档涵盖这些细节,并将模块侧 UI 和排序指南指向模块文档时,即视为完成。

由索引模型根据 Issue 内容生成。

描述

Bundle PR components-web-app/api-components-bundle#562 (issue #561) adds optimistic concurrency for components and page data. To document:

  • _metadata.version: an integer for each row, set by Doctrine's #[ORM\Version]. A draft has its own version, starting at 1. Signed-in responses also send ETag: "<version>"; anonymous responses are unchanged.
  • If-Match: "<version>" on PATCH, PUT and DELETE is compared with the row the URL addresses. A stale version gets 412 with the current resource in GET shape. A write to a published IRI that would be redirected to an existing draft also gets 412, with the draft as the body.
  • A save that loses a race at commit gets 412 too, with or without If-Match. A DELETE is checked only against If-Match.
  • The order PATCH and /move ignore If-Match.
  • Upgrade: a new resource_version column, so run doctrine:migrations:diff.
  • CORS for cross-origin apps: expose ETag and allow If-Match.

The module side (conflict UI, ordering updates by version) is the module's own docs.

主要语言
TypeScript
星标
0
派生
0
平均合并
1 小时 20 分钟
30 天内合并 PR
1

环境准备

这个项目没有提供开发容器、Dockerfile 或贡献指南,环境需要你自己搭建:先看它的 README,通用步骤见我们的新手贡献指南。

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

components-web-app/docs 的其他 Issue

查看 components-web-app/docs 的全部 Issue

相似的 Issue

更多 TypeScript Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。