Skip to content

DEV-8096 レスポンス内のprice, quantity関連の型をnumber -> stringに変更 #25

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
takak merged 2 commits into from
Apr 11, 2025
Merged

DEV-8096 レスポンス内のprice, quantity関連の型をnumber -> stringに変更 #25

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c701580
Fix: DEV-8096 レスポンス内のprice, quantity関連の型をnumber -> stringに変更
takak Apr 11, 2025
5bfb491
Fix: DEV-8096 Github Actionsで利用している actions/upload-artifact のv3がdepre…
takak Apr 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/gh-pages.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ jobs:
- name: Build Document
run: yarn build

- uses: actions/upload-artifact@v3
- uses: actions/upload-artifact@v4
if: success()
with:
name: API Document
Expand Down
1,659 changes: 1,467 additions & 192 deletions dist/index.html
View file
Open in desktop

Large diffs are not rendered by default.

10 changes: 5 additions & 5 deletions includes/api/inventories.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,7 +177,7 @@

### InventoryCreateParams
+ title: `在庫データ` (string, required) - 在庫データタイトル
+ quantity: 10 (number) - 数量
+ quantity: 10 (string) - 数量
+ unit: `個` (string) - 単位
+ category: `製品` (string) - カテゴリ
+ state: `新品` (string) - 状態
Expand All @@ -194,7 +194,7 @@
+ name: `追加項目名` (string) - 追加項目名
+ value: `追加項目値` (string) - 追加項目値
+ quantity_management_attributes
+ order_point_quantity: 5 (number) - 発注点
+ order_point_quantity: 5 (string) - 発注点
+ inventory_history
+ memo: `変更履歴メモ` (string) - 変更履歴のメモ
+ is_quantity_auto_conversion_by_unit: `1` (string) - 単位換算するかどうか。"1"なら単位換算する、"0"なら単位換算しない
Expand All @@ -204,8 +204,8 @@
### InventoriesViews
+ id: 1 (number) - ID
+ title: `在庫データ` (string) - 在庫データタイトル
+ quantity: 10 (number) - 数量
+ logical_quantity: 10 (number) - 予定フリー在庫数（フルプランのみ）
+ quantity: 10 (string) - 数量
+ logical_quantity: 10 (string) - 予定フリー在庫数（フルプランのみ）
+ unit: `個` (string) - 単位
+ category: `製品` (string) - カテゴリ
+ state: `新品` (string) - 状態
Expand All @@ -222,7 +222,7 @@
+ name: `追加項目名` (string) - 追加項目名
+ value: `追加項目値` (string) - 追加項目値
+ quantity_management_attributes
+ order_point_quantity: 5 (number) - 発注点
+ order_point_quantity: 5 (string) - 発注点
+ created_at: `2018-03-27T09:38:19+09:00` (string) - 作成日
+ updated_at `2018-03-27T09:38:19+09:00` (string) - 更新日
+ create_user_name: `田村 太郎` (string) - 作成者
Expand Down
30 changes: 15 additions & 15 deletions includes/api/inventories_sets.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,29 +41,29 @@
+ (object)
+ id: 123 (number) - ID
+ title: `セット品A` (string) - セット品名
+ price: 1000 (number) - 価格
+ price: 1000 (string) - 価格
+ code: `123456` (string) - コード
+ memo: `メモ` (string) - メモ
+ update_user_id: 1 (number) - 更新ユーザーID
+ available_delivery_quantity: 5 (number) - 出庫可能数量
+ available_delivery_quantity: 5 (string) - 出庫可能数量
+ created_at: `2022-01-01 09:00:00` (string) - 作成日時
+ updated_at: `2022-01-02 10:00:00` (string) - 更新日時
+ inventories_set_items (array[object], fixed-type)
+ (object)
+ inventory_id: 1 (number) - 在庫ID
+ quantity: 1 (number) - 数量
+ quantity: 1 (string) - 数量
+ created_at: `2022-01-01 09:00:00` (string) - 作成日時
+ updated_at: `2022-01-02 10:00:00` (string) - 更新日時
+ inventory_title: `構成部品A` (string) - 在庫名
+ inventory_quantity: 10 (number) - 在庫数量
+ inventory_quantity: 10 (string) - 在庫数量
+ inventory_del_flg: false (boolean) - 在庫削除フラグ
+ (object)
+ inventory_id: 2 (number)
+ quantity: 2 (number)
+ quantity: 2 (string)
+ created_at: `2022-01-01 09:00:00` (string)
+ updated_at: `2022-01-02 10:00:00` (string)
+ inventory_title: `構成部品B` (string)
+ inventory_quantity: 20 (number)
+ inventory_quantity: 20 (string)
+ inventory_del_flg: false (boolean)

## セット品データ作成 [/api/v1/inventories_sets]
Expand Down Expand Up @@ -139,32 +139,32 @@
+ Attributes
+ id: 123 (number) - セット品ID
+ title: `セット品A` (string) - セット品名
+ price: 1000 (number) - 価格
+ price: 1000 (string) - 価格
+ code: `123456` (string) - コード
+ memo: `メモ` (string) - メモ
+ update_user_id: 1 (number) - 更新ユーザーID
+ available_delivery_quantity: 5 (number) - 出庫可能数量
+ available_delivery_logical_quantity: 3 (number) - 予定フリー出庫可能数量
+ available_delivery_quantity: 5 (string) - 出庫可能数量
+ available_delivery_logical_quantity: 3 (string) - 予定フリー出庫可能数量
+ created_at: `2022-01-01 09:00:00` (string) - 作成日時
+ updated_at: `2022-01-02 10:00:00` (string) - 更新日時
+ inventories_set_items (array[object], fixed-type)
+ (object)
+ inventory_id: 1 (number) - 在庫ID
+ quantity: 1 (number) - 数量
+ quantity: 1 (string) - 数量
+ created_at: `2022-01-01 09:00:00` (string) - 作成日時
+ updated_at: `2022-01-02 10:00:00` (string) - 更新日時
+ inventory_title: `構成部品A` (string) - 在庫名
+ inventory_quantity: 10 (number) - 在庫数量
+ inventory_logical_quantity: 8 (number) - 予定フリー在庫数
+ inventory_quantity: 10 (string) - 在庫数量
+ inventory_logical_quantity: 8 (string) - 予定フリー在庫数
+ inventory_del_flg: false (boolean) - 在庫削除フラグ
+ (object)
+ inventory_id: 2 (number)
+ quantity: 2 (number)
+ quantity: 2 (string)
+ created_at: `2022-01-01 09:00:00` (string)
+ updated_at: `2022-01-02 10:00:00` (string)
+ inventory_title: `構成部品B` (string)
+ inventory_quantity: 20 (number)
+ inventory_logical_quantity: 18 (number)
+ inventory_quantity: 20 (string)
+ inventory_logical_quantity: 18 (string)
+ inventory_del_flg: false (boolean)

+ Response 404 (application/json)
Expand Down
6 changes: 3 additions & 3 deletions includes/api/inventory_group_items.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -132,9 +132,9 @@
### InventoryGroupItemsViews
+ id: 1 (number) - ID
+ title: `在庫データ` (string) - タイトル
+ quantity: 10 (number) - 数量
+ logical_quantity: 10 (number) - 予定フリー在庫数
+ order_point_quantity: 10 (number) - 発注点（発注点機能がONの場合のみ）
+ quantity: 10 (string) - 数量
+ logical_quantity: 10 (string) - 予定フリー在庫数
+ order_point_quantity: 10 (string) - 発注点（発注点機能がONの場合のみ）
+ order_point_warning: false (boolean) - 発注点の警告ON/OFF（発注点機能がONの場合のみ）
+ group_value: `グループタグ` (string) - グループタグ
+ created_at: `2018-03-27T09:38:19+09:00` (string) - 作成日
Expand Down
32 changes: 16 additions & 16 deletions includes/api/packing_slips.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -90,9 +90,9 @@
+ id: 1 (number)
+ inventory_id: 1 (number)
+ title: 掃除機 (string) - 物品名
+ quantity: 3 (number) - 出庫数量
+ quantity: 3 (string) - 出庫数量
+ unit: 台 (string) - 単位
+ unit_price: 100 (number) - 納品単価
+ unit_price: 100 (string) - 納品単価
+ status: completed_delivery (string)
+ delivery_date: `2019-09-01` (string)
+ estimated_delivery_date (string, optional, nullable)
Expand All @@ -101,9 +101,9 @@
+ id: 2 (number)
+ inventory_id: 2 (number)
+ title: テレビ (string) - 物品名
+ quantity: 3 (number) - 出庫数量
+ quantity: 3 (string) - 出庫数量
+ unit: 台 (string) - 単位
+ unit_price: 100 (number) - 納品単価
+ unit_price: 100 (string) - 納品単価
+ status: completed_delivery (string)
+ delivery_date: `2019-09-01` (string)
+ estimated_delivery_date (string, optional, nullable)
Expand All @@ -112,11 +112,11 @@
+ id: 3 (number)
+ inventory_id: 3 (number)
+ title: ビール (string) - 物品名
+ quantity: 12 (number) - 出庫数量
+ quantity: 12 (string) - 出庫数量
+ box_quantity: 1 (string) - まとめ換算の入庫数量
+ unit: 瓶 (string) - 単位
+ box_unit: 箱 (string) - まとめ単位
+ unit_price: 100 (number) - 納品単価
+ unit_price: 100 (string) - 納品単価
+ unit_snapshot:
+ piece_name: 瓶 (string) - 基本単位名称
+ box_name: 箱 (string) - まとめ単位名称
Expand All @@ -140,9 +140,9 @@
+ (object)
+ inventory_id: 5 (number)
+ title: 掃除機 (string) - 物品名
+ quantity: 3 (number) - 出庫数量
+ quantity: 3 (string) - 出庫数量
+ unit: 台 (string) - 単位
+ unit_price: 100 (number) - 納品単価
+ unit_price: 100 (string) - 納品単価
+ status: completed_delivery
+ delivery_date: `2019-09-01`
+ estimated_delivery_date: `2019-09-01` (string, optional, nullable)
Expand Down Expand Up @@ -311,19 +311,19 @@
+ (object)
+ inventory_id: 1 (number)
+ title: 掃除機 (string) - 物品名
+ quantity: 3 (number) - 出庫数量
+ quantity: 3 (string) - 出庫数量
+ unit: 台 (string) - 単位
+ unit_price: 100 (number) - 納品単価
+ unit_price: 100 (string) - 納品単価
+ status: completed_delivery (string)
+ delivery_date: `2019-09-01` (string)
+ estimated_delivery_date (string, optional, nullable)
+ etc: 白色 (string) - 摘要・備考
+ (object)
+ inventory_id: 2 (number)
+ title: テレビ (string) - 物品名
+ quantity: 3 (number) - 出庫数量
+ quantity: 3 (string) - 出庫数量
+ unit: 台 (string) - 単位
+ unit_price: 100 (number) - 納品単価
+ unit_price: 100 (string) - 納品単価
+ status: completed_delivery (string)
+ delivery_date: `2019-09-01` (string)
+ estimated_delivery_date: `2019-09-01` (string, optional, nullable)
Expand Down Expand Up @@ -474,9 +474,9 @@
+ packing_slip_id: 10 (number)
+ inventory_id: 1 (number)
+ title: 掃除機 (string)
+ quantity: 3 (number)
+ quantity: 3 (string)
+ unit: 台 (string)
+ unit_price: 100 (number)
+ unit_price: 100 (string)
+ status: completed_delivery (string)
+ delivery_date: 2021-11-17 (string)
+ estimated_delivery_date: (string, nullable)
Expand All @@ -488,9 +488,9 @@
+ packing_slip_id: 10 (number)
+ inventory_id: 1 (number)
+ title: 掃除機 (string)
+ quantity: 3 (number)
+ quantity: 3 (string)
+ unit: 台 (string)
+ unit_price: 100 (number)
+ unit_price: 100 (string)
+ status: completed_delivery (string)
+ delivery_date: 2021-11-17 (string)
+ estimated_delivery_date: (string, nullable)
Expand Down
10 changes: 5 additions & 5 deletions includes/api/purchases.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@ HOST: https://web.zaico.co.jp/
* 以下の3つのいずれかが設定されています
* not_ordered : 発注前
* ordered : 発注済み
* purchased : 入庫済み
* purchased : 入庫済
* purchase_date: 入庫日
* estimated_purchase_date : 入庫予定日
* etc : 入庫物品メモ
Expand Down Expand Up @@ -506,9 +506,9 @@ HOST: https://web.zaico.co.jp/
+ purchase_id: 10 (number)
+ inventory_id: 1 (number)
+ title: 掃除機 (string)
+ quantity: 3 (number)
+ quantity: 3 (string)
+ unit: 台 (string)
+ unit_price: 100 (number)
+ unit_price: 100 (string)
+ status: purchased (string)
+ purchase_date: 2021-11-17 (string)
+ estimated_purchase_date: (string, nullable)
Expand All @@ -519,9 +519,9 @@ HOST: https://web.zaico.co.jp/
+ purchase_id: 10 (number)
+ inventory_id: 2 (number)
+ title: りんご (string)
+ quantity: 10 (number)
+ quantity: 10 (string)
+ unit: 個 (string)
+ unit_price: 200 (number)
+ unit_price: 200 (string)
+ status: purchased (string)
+ purchase_date: 2021-11-17 (string)
+ estimated_purchase_date: (string, nullable)
Expand Down
Loading