From daec6a8544e1cb122c3560e9e1f6cfeb02b1bae8 Mon Sep 17 00:00:00 2001 From: Takafumi Miyanaga Date: Thu, 5 Sep 2024 16:24:45 +0900 Subject: [PATCH] docs:update openapi.md (#13) --- docs/en/developer_guidelines/openapi.md | 4 ++-- docs/ja/architecture/sequence_diagram.md | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/en/developer_guidelines/openapi.md b/docs/en/developer_guidelines/openapi.md index b050967..9fa53cf 100644 --- a/docs/en/developer_guidelines/openapi.md +++ b/docs/en/developer_guidelines/openapi.md @@ -69,8 +69,8 @@ paths: - The paths directly under the resource should refer to the `root` in the files placed in the `paths` directory. - Deeper nested paths should be defined as `root.{path_name}.{path_name}`. -!!! note - Define as `task/{taskId}` instead of `task/{task_id}`. +> [!NOTE] +> Define as `task/{taskId}` instead of `task/{task_id}`. ## How to Write `paths` diff --git a/docs/ja/architecture/sequence_diagram.md b/docs/ja/architecture/sequence_diagram.md index d452188..4af2b38 100644 --- a/docs/ja/architecture/sequence_diagram.md +++ b/docs/ja/architecture/sequence_diagram.md @@ -59,9 +59,9 @@ sequenceDiagram Provider は定期的に、タスクのフェッチ・タスクの実行・実行結果の送信、の流れを繰り返します。 上図では 1 回分の流れを記載しています。 -!!! note - Cloud はフェッチ済みか否か (status の末尾に _FETCHED が付くか否か) の情報を Provider に対してのみ公開します。 - 例えば、ユーザーが QUEUED_FETCHED のタスク情報を Cloud から取得すると status は QUEUED になっており、Provider が取得すると status は QUEUED_FETCHED になっています。 +> [!NOTE] +> Cloud はフェッチ済みか否か (status の末尾に _FETCHED が付くか否か) の情報を Provider に対してのみ公開します。 +> 例えば、ユーザーが QUEUED_FETCHED のタスク情報を Cloud から取得すると status は QUEUED になっており、Provider が取得すると status は QUEUED_FETCHED になっています。 ### 各時点における DB 内のデータ