--verboseの安全な識別情報と実行メタデータを拡充する#13
Merged
Merged
Conversation
## 概要 `--verbose`で出力するBacklog APIアクセス情報をJSON形式へ統一し、ホワイトリストで許可したリソース識別情報と実行メタデータを追加します。通常のstdout契約を維持しつつ、認証情報、本文、個人情報、検索語、エラー本文などはverboseログへ出力しません。 ## 変更内容 - startとsuccessまたはfailureで同じアクセス番号を使用する、`verbose: `プレフィックス付きJSONイベントへ変更 - 入力からスペース、プロジェクト、課題、Wiki、Gitリポジトリ、プルリクエスト、コメント、添付ファイルの安全なID・キーだけを抽出して`target`へ追加 - 成功結果から許可したID・キーだけを抽出して`result`へ追加 - `durationMs`、値を含まない`changedFields`、`offset`・`count`のページング情報を追加 - 失敗オブジェクトが実際に公開している場合のみ`httpStatus`を追加し、成功ステータスは推測しない - README、CLIヘルプ、開発資料、トレーサビリティ資料を新しいverbose契約へ更新 - Backlog APIのレート制限について、ユーザー単位の制限、レスポンスヘッダー、運用上の管理単位、今後の実装指針を文書化 - READ、CREATE、UPDATE、DELETEの代表操作と、検索語や本文などの情報漏洩防止をテスト - バージョンを`0.3.4`へ更新 ## 検証 - `npm run typecheck` - `npm test`（28テスト成功） - `npm run smoke:node` - `git diff --check` ## 関連Issue Closes #10 Refs #12
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
概要
--verboseで出力するBacklog APIアクセス情報をJSON形式へ統一し、ホワイトリストで許可したリソース識別情報と実行メタデータを追加します。通常のstdout契約を維持しつつ、認証情報、本文、個人情報、検索語、エラー本文などはverboseログへ出力しません。変更内容
verbose:プレフィックス付きJSONイベントへ変更targetへ追加resultへ追加durationMs、値を含まないchangedFields、offset・countのページング情報を追加httpStatusを追加し、成功ステータスは推測しない0.3.4へ更新検証
npm run typechecknpm test（28テスト成功）npm run smoke:nodegit diff --check関連Issue
Closes #10
Refs #12