表示義務と表示推奨

ぺったんRはwebで漫画を作るサイトの規格を策定することを試みているので、ぺったんAPIを開放するとともに、最低限あるべき姿を取り決めようともしている。その一つとして、データの正しい(フェアな)使い方を提示する。ここで書かれる義務はソフトウェアのライセンスとは関係なく、どちらかと言えばサーバ運営者がAPIの利用に際してユーザと交わすAPI規約的な性質のものである。ぺったんRチームでは、ソフトウェアの配布や改変の自由を確保するかわりに、ロゴなどの利用を制限して安心感を維持しようと考えている。

具体的な義務内容は各機能(コントローラRailsControllers)に記述する。

表示義務

  • データベースから取得した情報を表示するときは、必ず表示義務のあるカラムを表示しなければならない。

  • コミックComicを表示するときは、タイトルと作家名を表示しなければならない。
  • 作家名を表示するときは、作家の詳細ページへ誘導するリンクを用意しなければならない。

表示推奨

  • データベースから取得した情報を表示するときは、表示推奨のカラムを表示した方が良い。

  • コミックComicを表示するときは、最新投稿日時を表示した方が良い。