Skip to content

Commit

Permalink
docs:update openapi.md (#13)
Browse files Browse the repository at this point in the history
  • Loading branch information
orangekame3 authored Sep 5, 2024
1 parent 48edda5 commit daec6a8
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 5 deletions.
4 changes: 2 additions & 2 deletions docs/en/developer_guidelines/openapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`

Expand Down
6 changes: 3 additions & 3 deletions docs/ja/architecture/sequence_diagram.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 内のデータ

Expand Down

0 comments on commit daec6a8

Please sign in to comment.