Hacktoberfest 2026:メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

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

オープン 初心者向け
#297 コメント 0 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
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分
マージ済み PR(30日)
1

環境構築

このプロジェクトには開発コンテナ、Dockerfile、コントリビューションガイドがありません。まず README を読み、一般的な手順ははじめてのコントリビューションガイドを参照してください。

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

components-web-app/docs のほかの issue

components-web-app/docs の issue をすべて見る

似ている issue

TypeScript の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。