違反報告APIの拡張

[ippei-fukamatsu]

概要

現状記事に対して違反しているというデータしか持っていないが、
申告者がより詳細に報告をできるよう、APIの受け口を広げました。
追加項目

• 申告理由(必須)
• 元記事URL(申告理由が著作権違反の場合必須)
• 補足説明(申告理由が著作権違反の場合必須)
• 不正内容(申告理由が不正なトークン取得の場合必須)

環境変数(SSMパラメータ)

なし

関連URL

影響範囲(ユーザ)

• ユーザー

影響範囲(システム)

• 影響を与えるシステムはどこか

• サーバレス

技術的変更点概要

• なにをどう変更したか
  当該APIのリクエストにJSONで受け取れるように受け皿を作り、データ登録時の項目を増やした

• memo: 複合条件での入力チェックについて
  今回の場合、例えば申告理由が著作権違反の場合は、元記事URLと補足説明を必須にする必要があると考えた。
  その複合条件のチェックをjsonschemaでやろうと調べまくったが、結論本家のバージョンdraft-07から開始したらしい。。
  （Pythonライブラリのjsonschemaはdraft-6までをサポート）
  悲しいが今回は自作しました。

参考URL
https://github.com/Julian/jsonschema
http://json-schema.org/draft-07/json-schema-release-notes.html
https://stackoverflow.com/questions/38717933/jsonschema-attribute-conditionally-required

使い方

• 使い方の説明
• バグの場合は再現条件

DBやDBへのクエリに対する変更

• DBのスキーマに変更があるか
  • 変更がある場合はドキュメントに反映
    ※レビュー通りましたらドキュメントに正式反映いたします

項目名	データ型	概要/用途
reason	String	申告理由(Enum) violence(公序良俗に反する) spam(迷惑行為) plagiarism(著作権違反) slander(誹謗中傷) illegal(トークン不正取得) other(その他)
plagiarism_url	String	盗作した元記事URL
plagiarism_description	String	盗作に関する補足説明
illegal_content	String	申告内容の詳細説明

ブロックチェーンへの影響

なし

個人情報の取り扱いに変更のあるリリースか

なし

ロギング

なし

ユニットテスト

あり

テスト結果とテスト項目

• 違反申告を行い、正常に登録されることを確認する

保留した項目とTODOリスト

なし

注意点・その他

• この作業で特に注意する点があれば記載する
• その他、補足事項があれば記載する

[ippei-fukamatsu]

forkした方からPR出し直したので、こちら一旦クローズします。
#138