382 lines
9.0 KiB
Markdown
382 lines
9.0 KiB
Markdown
# /docs
|
|
|
|
ドキュメントに関するAPIです。
|
|
|
|
## /{id}
|
|
|
|
?
|
|
|
|
| HTTP Method | Description | |
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
|
|
|
:arrow_forward: ^^リクエスト^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルリクエストデータ
|
|
|
|
``` JSON title="JSON"
|
|
TBD
|
|
```
|
|
|
|
:arrow_backward: ^^レスポンス^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルレスポンスデータ
|
|
|
|
``` JSON title="JSON"
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
|
```
|
|
|
|
!!! 補足
|
|
|
|
* 最終更新日： 2025/xx/xx
|
|
|
|
??? フリーメモ
|
|
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
|
* 自由なメモを記載できます
|
|
|
|
<br>
|
|
|
|
## /details/{id}
|
|
|
|
?
|
|
|
|
| HTTP Method | Description | |
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
|
|
|
:arrow_forward: ^^リクエスト^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルリクエストデータ
|
|
|
|
``` JSON title="JSON"
|
|
TBD
|
|
```
|
|
|
|
:arrow_backward: ^^レスポンス^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルレスポンスデータ
|
|
|
|
``` JSON title="JSON"
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
|
```
|
|
|
|
!!! 補足
|
|
|
|
* 最終更新日： 2025/xx/xx
|
|
|
|
??? フリーメモ
|
|
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
|
* 自由なメモを記載できます
|
|
|
|
<br>
|
|
|
|
## /ownerlist
|
|
|
|
?
|
|
|
|
| HTTP Method | Description | |
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
|
|
|
:arrow_forward: ^^リクエスト^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルリクエストデータ
|
|
|
|
``` JSON title="JSON"
|
|
TBD
|
|
```
|
|
|
|
:arrow_backward: ^^レスポンス^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルレスポンスデータ
|
|
|
|
``` JSON title="JSON"
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
|
```
|
|
|
|
!!! 補足
|
|
|
|
* 最終更新日： 2025/xx/xx
|
|
|
|
??? フリーメモ
|
|
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
|
* 自由なメモを記載できます
|
|
|
|
<br>
|
|
|
|
## /search
|
|
|
|
?
|
|
|
|
| HTTP Method | Description | |
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
|
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
|
|
|
:arrow_forward: ^^リクエスト^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルリクエストデータ
|
|
|
|
``` JSON title="JSON"
|
|
TBD
|
|
```
|
|
|
|
:arrow_backward: ^^レスポンス^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルレスポンスデータ
|
|
|
|
``` JSON title="JSON"
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
|
```
|
|
|
|
!!! 補足
|
|
|
|
* 最終更新日： 2025/xx/xx
|
|
|
|
??? フリーメモ
|
|
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
|
* 自由なメモを記載できます
|
|
|
|
<br>
|
|
|
|
## /search/createdby
|
|
|
|
Same as '/search' but search with created_by login user and other conditions.
|
|
|
|
?
|
|
|
|
| HTTP Method | Description | |
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
|
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
|
|
|
:arrow_forward: ^^リクエスト^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルリクエストデータ
|
|
|
|
``` JSON title="JSON"
|
|
TBD
|
|
```
|
|
|
|
:arrow_backward: ^^レスポンス^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルレスポンスデータ
|
|
|
|
``` JSON title="JSON"
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
|
```
|
|
|
|
!!! 補足
|
|
|
|
* 最終更新日： 2025/xx/xx
|
|
|
|
??? フリーメモ
|
|
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
|
* 自由なメモを記載できます
|
|
|
|
<br>
|
|
|
|
## /update/attrib
|
|
|
|
?
|
|
|
|
| HTTP Method | Description | |
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
|
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
|
|
|
:arrow_forward: ^^リクエスト^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルリクエストデータ
|
|
|
|
``` JSON title="JSON"
|
|
TBD
|
|
```
|
|
|
|
:arrow_backward: ^^レスポンス^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルレスポンスデータ
|
|
|
|
``` JSON title="JSON"
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
|
```
|
|
|
|
!!! 補足
|
|
|
|
* 最終更新日： 2025/xx/xx
|
|
|
|
??? フリーメモ
|
|
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
|
* 自由なメモを記載できます
|
|
|
|
<br>
|
|
|
|
## /upload
|
|
|
|
?
|
|
|
|
| HTTP Method | Description | |
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
|
| `POST` | <span style="color: green; ">:material-check:</span> Create resource | データの送信 (主に新規作成) |
|
|
|
|
:arrow_forward: ^^リクエスト^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルリクエストデータ
|
|
|
|
``` JSON title="JSON"
|
|
TBD
|
|
```
|
|
|
|
:arrow_backward: ^^レスポンス^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルレスポンスデータ
|
|
|
|
``` JSON title="JSON"
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
|
```
|
|
|
|
!!! 補足
|
|
|
|
* 最終更新日： 2025/xx/xx
|
|
|
|
??? フリーメモ
|
|
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
|
* 自由なメモを記載できます
|
|
|
|
<br>
|
|
|
|
## /viewlist
|
|
|
|
?
|
|
|
|
| HTTP Method | Description | |
|
|
| ---------------- | -------------------------------------- | ---------------------------------- |
|
|
| `GET` | <span style="color: green; ">:material-check:</span> Fetch resource | データの取得 |
|
|
|
|
:arrow_forward: ^^リクエスト^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルリクエストデータ
|
|
|
|
``` JSON title="JSON"
|
|
TBD
|
|
```
|
|
|
|
:arrow_backward: ^^レスポンス^^
|
|
|
|
パラメータ
|
|
|
|
| 名称 | 型 | 例 | 必須 | 説明 |
|
|
| ---- | --- | --- | --- | --- |
|
|
| _ | _ | _ | _ | 説明がここに記述されます。 |
|
|
|
|
サンプルレスポンスデータ
|
|
|
|
``` JSON title="JSON"
|
|
{"id":"hogefuga","secret":"abrakadabra"}
|
|
```
|
|
|
|
!!! 補足
|
|
|
|
* 最終更新日： 2025/xx/xx
|
|
|
|
??? フリーメモ
|
|
|
|
* エンジニアが共有などのメモを残していくことができるエリアです
|
|
* 自由なメモを記載できます
|
|
|
|
<br>
|