From 22994331587598c10dc7422a377ab0abc09cd702 Mon Sep 17 00:00:00 2001 From: ItAdmin Date: Wed, 22 Apr 2026 05:02:12 +0000 Subject: [PATCH] =?UTF-8?q?"/"=20=E3=81=AB=E3=83=95=E3=82=A1=E3=82=A4?= =?UTF-8?q?=E3=83=AB=E3=82=92=E3=82=A2=E3=83=83=E3=83=97=E3=83=AD=E3=83=BC?= =?UTF-8?q?=E3=83=89?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- index.md | 31 +++ index01.md | 42 ++++ index02.md | 476 +++++++++++++++++++++++++++++++++++++++++ index03.md | 614 +++++++++++++++++++++++++++++++++++++++++++++++++++++ index04.md | 381 +++++++++++++++++++++++++++++++++ 5 files changed, 1544 insertions(+) create mode 100644 index.md create mode 100644 index01.md create mode 100644 index02.md create mode 100644 index03.md create mode 100644 index04.md diff --git a/index.md b/index.md new file mode 100644 index 0000000..c6d6e3d --- /dev/null +++ b/index.md @@ -0,0 +1,31 @@ +# Home + +## お知らせ + +| 掲載日 | 内容 | +| ---------- | ------------------ | +| 2025/11/14 | 本サイトをベータ版として公開開始しました | + +## メンテナンス情報 + +WorkFlow+サポートチームからメンテナンスのご連絡です。 + +■日程 + +日本時間/JST + +2025年11月21日(金) 23:00　から　2025年11月22日(土) 2:00頃　まで + +■更新事項 + +・API機能リリース +
+・セキュリティパッチ最新バージョンの適用 +サーバの再起動を予定しており、ログインや入力保存操作が不安定となります。 + +
+以上、ご案内申し上げます。 + +
+With best regards, +WorkFlow+ Support Team diff --git a/index01.md b/index01.md new file mode 100644 index 0000000..500609d --- /dev/null +++ b/index01.md @@ -0,0 +1,42 @@ +# APIの概要 + +## API Endpoint + +APIエンドポイントのurlは下記です（要調査事項）。 + +| 環境 | Base url | 説明 | +| ---- | ------------------------- | --- | +| Live | https://hogehoge.org/api/ | --- | +| Dev | https://fugafuga.org/api/ | --- | + +## 認証とコール方法 + +APIコールを行う際に、認証情報をAPIサーバに送る方法は、ログイン時に発行されセッションクッキーに格納されるセッション固有文字列（ACCESS_TOKEN）をAPIコール時にHTTP-Headerに込める方式です。 + +``` curl title="cUrlでのAPIコールの例（GET）" linenums="1" +curl -X GET "https://example.com/api/resource" \ + -H "Authorization: Bearer ACCESS_TOKEN" +``` + +``` curl title="cUrlでのAPIコールの例（POST）" linenums="1" +curl -X POST "https://example.com/api/resource" \ + -H "Authorization: Bearer ACCESS_TOKEN" \ + -H "Content-Type: application/json" \ + -d '{"key1":"value1","key2":"value2"}' +``` + +## RESTful API視点での実装状況 + +RESTful APIではHTTP Methodと行うことを紐付けていますが、現状ではPOSTでデータ削除を行ったりとRESTfulとは言えない仕様が散見されます。すべてを突然変えるのは困難なので、可能な範囲で摺り寄せていければよいのではないでしょうか。 + +| HTTP Method | Description | | | +| ---------------- | -------------------------- | ---------------------------------- | --- | +| `GET` | Fetch resource | データの取得 | | +| `POST` | Create resource | データの送信 (主に新規作成) | | +| `PUT` | Update resource | データの送信 (主に既存データの更新) | 実装なし | +| `DELETE` | Delete resource | データの削除 | 実装なし | +| | | | | +| `PATCH` | Partially update resource | データの送信 (主に既存データの一部更新) | 実装なし | +| `OPTIONS` | Confirm available methods | データの取得 (使用可能なメソッド閲覧) | 実装なし | +| `HEAD` | Confirm alive | データの取得 (レスポンスヘッダー閲覧) | 実装なし | +| `TRACE` | Confirm server path | データの取得 (サーバーパス閲覧) | 実装なし | diff --git a/index02.md b/index02.md new file mode 100644 index 0000000..178ae15 --- /dev/null +++ b/index02.md @@ -0,0 +1,476 @@ +# /cp + +テンプレートファイル自体に関するAPIです。 + +## /delete/{pageid} + +{pageid}で指定したテンプレートを削除する。 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /file/{filename} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /get_pageid + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /isreportowner/{pageid} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /list + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /ownerlist + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /page/{pageid} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /reportownerlist + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /templates/{filename} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /update + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | ? Fetch resource | データの取得 | +| `POST` | ? Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
diff --git a/index03.md b/index03.md new file mode 100644 index 0000000..4d253d2 --- /dev/null +++ b/index03.md @@ -0,0 +1,614 @@ +# /csv + +CSVに関するAPIです。※Power BI連携を見据えたAPI + +## /{id} + +get csv file + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /append/ + +データ追加 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /columnize/{id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /data/{id} + +データ表示 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /drop/{id} + +ファイル削除 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /file/{id} + +ファイルダウンロード + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /json/{id} + +データ表示（JSON形式） + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /list + +一覧表示 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /meta{id} + +メタデータ取得 + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /new + +CSVファイルを新規アップロードする + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /ownerlist + +一覧表示（owner権限のあるファイル） + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /update/{id} + +すでにアップロードされているCSVファイルを差し替える + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /update/meta/{id} + +メタデータを更新する + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
diff --git a/index04.md b/index04.md new file mode 100644 index 0000000..85f4ff0 --- /dev/null +++ b/index04.md @@ -0,0 +1,381 @@ +# /docs + +ドキュメントに関するAPIです。 + +## /{id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /details/{id} + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /ownerlist + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /search + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /search/createdby + +Same as '/search' but search with created_by login user and other conditions. + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /update/attrib + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /upload + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `POST` | :material-check: Create resource | データの送信 (主に新規作成) | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +
+ +## /viewlist + +? + +| HTTP Method | Description | | +| ---------------- | -------------------------------------- | ---------------------------------- | +| `GET` | :material-check: Fetch resource | データの取得 | + +:arrow_forward: ^^リクエスト^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルリクエストデータ + +``` JSON title="JSON" +TBD +``` + +:arrow_backward: ^^レスポンス^^ + +パラメータ + +| 名称 | 型 | 例 | 必須 | 説明 | +| ---- | --- | --- | --- | --- | +| _ | _ | _ | _ | 説明がここに記述されます。 | + +サンプルレスポンスデータ + +``` JSON title="JSON" +{"id":"hogefuga","secret":"abrakadabra"} +``` + +!!! 補足 + + * 最終更新日： 2025/xx/xx + +??? フリーメモ + + * エンジニアが共有などのメモを残していくことができるエリアです + * 自由なメモを記載できます + +