CHANGELOG

API の変更履歴

API の変更をどのように告知し、記録するかの方針です。公開前のため、記録された変更はまだありません。

  1. 公開前

    ここから、記録が始まります。

    最初の公開以降、更新のたびに、日付・タグ・変更点を、この上に追記します。新しい順に並びます。

  2. 題名（この更新で何が変わったか）

    記載例
    • 新機能追加したことを、1 行で書きます。
    • 改善よくなったことを、測定した事実だけで書きます。
    • 修正直した不具合を、書きます。

    API への影響：ある場合だけ、対応が必要かどうかを、書きます。

方針

  • 追加（後方互換）：新しい項目・エンドポイントの追加は、互換性を保つ変更として、リリース時に記録します。クライアントは、知らない項目を無視してください。
  • 破壊的な変更：項目の削除・意味の変更・エラー形式の変更は、破壊的な変更として、実施前に告知し、変更履歴に明記します。告知から実施までの期間は 確定待ち です。
  • 非推奨：廃止する機能は、先に「非推奨」としてドキュメントに明記します。
  • モデルの更新：月次のデータ更新・モデルの更新は、モデルの更新履歴（/models/kiten/changelog）に書きます。

モデルの品質・機能の履歴は Kiten の更新履歴にあります。更新は、RSS でも受け取れます。

この内容に誤りや不足があれば、お知らせください。