Skip to content

docs: DEV-8994 v1非メンテ告知の追加と更新時必須仕様の追記 - #33

Merged
fukata merged 1 commit into
masterfrom
DEV-8994
Jun 15, 2026
Merged

docs: DEV-8994 v1非メンテ告知の追加と更新時必須仕様の追記#33
fukata merged 1 commit into
masterfrom
DEV-8994

Conversation

@fukata

@fukata fukata commented Jun 15, 2026

Copy link
Copy Markdown
Member

Summary

  • 公開API v1 ドキュメント (zaico_api_doc) の上部に「v1 は今後大きなメンテナンスを予定していない」旨の警告ボックスを追加
  • deliveries / purchase_items更新時 に、status を「済」に変更する際の delivery_date / purchase_date 必須条件を追記(作成時 には記載済だが更新時には抜けていた)
  • 入庫データ作成の typo purcahse_datepurchase_date を修正
  • JIRA: DEV-8994

背景

  1. 公開API v2 のリンクは上部にあるが、v1 が今後大きなメンテナンスを予定していない旨の告知が無かった
  2. deliveries / purchase_items の更新時、status=completed_delivery / status=purchased への変更でも delivery_date / purchase_date は API 実装上必須だが、ドキュメントには明記されておらず利用者が気づきにくい状態だった

変更内容

  • api.md: 上部に黄色の警告ボックス(v1 非メンテ告知 + v2 ドキュメントリンク統合)を追加。<style>.v1-deprecation-notice を追加。更新日も 2026年6月15日 に更新
  • includes/api/packing_slips.md: 出庫データ更新エンドポイントの deliveries[].delivery_date に「status=completed_delivery のとき必須/before_delivery では不要」を追記
  • includes/api/purchases.md: 入庫データ更新エンドポイントの purchase_items[].purchase_date に「status=purchased のとき必須/not_ordered では不要」を追記。作成エンドポイント説明文の typo を修正
  • dist/index.html: 上記反映後の yarn build 結果

Test plan

  • yarn build でビルド成功(既存warningのみ、本PRの変更によるエラーなし)
  • dist/index.html に告知ボックス・追記内容が反映されていることを確認
  • GitHub Actions の Build Document ステップが成功すること
  • master マージ後、https://zaicodev.github.io/zaico_api_doc/ で告知ボックスが上部に表示され、各更新エンドポイントに必須条件の記載があることを確認

🤖 Generated with Claude Code

* api.md 上部に v1 非メンテナンス告知の警告ボックスを追加(v2 リンクは告知内に統合)
* 出庫データ更新の deliveries[].delivery_date に status=completed_delivery のとき必須である旨を追記
* 入庫データ更新の purchase_items[].purchase_date に status=purchased のとき必須である旨を追記
* 入庫データ作成の typo purcahse_date を purchase_date に修正
@fukata
fukata merged commit f5c81c1 into master Jun 15, 2026
1 check passed
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.

1 participant