From 592679a08e037d9a33b89b8f1bcec7a35d41ad5a Mon Sep 17 00:00:00 2001 From: Kubosaka Date: Tue, 24 Dec 2024 13:57:04 +0900 Subject: [PATCH] =?UTF-8?q?openapi.yml=E3=82=92=EF=BC=91=E3=81=A4=E3=81=AB?= =?UTF-8?q?=E3=81=BE=E3=81=A8=E3=82=81=E3=81=9F?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- compose.swagger.yml | 2 +- openapi/{generated => }/openapi.yaml | 0 swagger-ui/swagger.yaml | 2432 -------------------------- 3 files changed, 1 insertion(+), 2433 deletions(-) rename openapi/{generated => }/openapi.yaml (100%) delete mode 100644 swagger-ui/swagger.yaml diff --git a/compose.swagger.yml b/compose.swagger.yml index 4f8637166..7dfcdb896 100644 --- a/compose.swagger.yml +++ b/compose.swagger.yml @@ -5,6 +5,6 @@ services: ports: - "8000:8080" volumes: - - ./swagger-ui/swagger.yaml:/swagger.yaml + - ./openapi/openapi.yaml:/swagger.yaml environment: SWAGGER_JSON: /swagger.yaml diff --git a/openapi/generated/openapi.yaml b/openapi/openapi.yaml similarity index 100% rename from openapi/generated/openapi.yaml rename to openapi/openapi.yaml diff --git a/swagger-ui/swagger.yaml b/swagger-ui/swagger.yaml deleted file mode 100644 index 45545f0de..000000000 --- a/swagger-ui/swagger.yaml +++ /dev/null @@ -1,2432 +0,0 @@ -openapi: 3.0.1 -info: - title: NUTFes FinanSu API - description: FinanSu APIドキュメント - contact: {} - version: 2.0.0 -servers: - - url: http://localhost:1323/ -paths: - /activities: - get: - tags: - - activity - description: activitiesの一覧を取得 - responses: - "200": - description: activitiesの一覧の取得 - content: {} - post: - tags: - - activity - description: activitiesの作成 - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/activity" - required: false - responses: - "200": - description: create されたactivityが返ってくる - content: {} - x-codegen-request-body-name: activity - /activities/details: - get: - tags: - - activity - description: "activitiesとsponsor,sponsorStyle,userの一覧を取得" - responses: - "200": - description: "activitiesとsponsor,sponsorStyle,userの一覧の取得" - content: {} - /activities/details/{year}: - get: - tags: - - activity - description: "年度で指定されたactivitiesとsponsor,sponsorStyle,userの一覧を取得" - parameters: - - name: year - in: path - description: year - required: true - schema: - type: integer - responses: - "200": - description: "年度で指定されたactivitiesとsponsor,sponsorStyle,userの一覧を取得" - content: {} - /activities/filtered_details: - get: - tags: - - activity - description: "activitiesとsponsor,sponsorStyle,userの一覧を取得" - requestBody: - description: Filter by keyword - content: - "*/*": - schema: - type: string - required: false - responses: - "200": - description: "activitiesとsponsor,sponsorStyle,userの一覧の取得" - content: {} - x-codegen-request-body-name: keyword - /activities/filtered_details/{year}: - get: - tags: - - activity - description: "activitiesとsponsor,sponsorStyle,userの一覧を取得" - parameters: - - name: year - in: path - description: Filter by year. - required: true - schema: - type: string - requestBody: - description: Filter by keyword - content: - "*/*": - schema: - type: string - required: false - responses: - "200": - description: "activitiesとsponsor,sponsorStyle,userの一覧の取得" - content: {} - x-codegen-request-body-name: keyword - /activities/{id}: - get: - tags: - - activity - description: IDで指定されたactivitiesの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: activitiesの取得 - content: {} - put: - tags: - - activity - description: activitiesの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/activity" - required: false - responses: - "200": - description: 更新されたactivitiesが返ってくる - content: {} - x-codegen-request-body-name: activity - delete: - tags: - - activity - description: IDを指定してactivitiesの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: activitiesの削除完了 - content: {} - /activity_informations: - get: - tags: - - activity_information - description: activity_informationの一覧を取得 - responses: - "200": - description: activity_informationの一覧の取得 - content: {} - post: - tags: - - activity_information - description: activity_informationの作成 - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/activity_information" - required: false - responses: - "200": - description: create されたactivity_informationが返ってくる - content: {} - x-codegen-request-body-name: activity_information - /activity_informations/{id}: - get: - tags: - - activity_information - description: IDで指定されたactivity_informationsの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: activity_informationの取得 - content: {} - put: - tags: - - activity_information - description: activity_informationの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/activity_information" - required: false - responses: - "200": - description: 更新されたactivity_informationが返ってくる - content: {} - x-codegen-request-body-name: activity_information - delete: - tags: - - activity_information - description: IDを指定してactivity_informationの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: activity_informationの削除完了 - content: {} - /activity_styles: - get: - tags: - - activity_style - description: activity_styleの一覧を取得 - responses: - "200": - description: activity_styleの一覧の取得 - content: {} - post: - tags: - - activity_style - description: activity_styleの作成 - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/activity_style" - required: false - responses: - "200": - description: createされたactivity_styleが返ってくる - content: {} - x-codegen-request-body-name: activity_style - /activity_styles/{id}: - get: - tags: - - activity_style - description: IDで指定されたactivity_styleの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: activity_styleの取得 - content: {} - put: - tags: - - activity_style - description: activity_styleの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/activity_style" - required: false - responses: - "200": - description: 更新されたactivity_styleが返ってくる - content: {} - x-codegen-request-body-name: activity_style - delete: - tags: - - activity_style - description: IDを指定してactivity_styleの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: activity_styleの削除完了 - content: {} - /budgets: - get: - tags: - - budget - description: budgetの一覧を取得 - responses: - "200": - description: budgetの一覧の取得 - content: {} - post: - tags: - - budget - description: budgetの作成 - parameters: - - name: price - in: query - description: price - required: true - schema: - type: integer - - name: year_id - in: query - description: year_id - schema: - type: integer - - name: source_id - in: query - description: source_id - schema: - type: integer - responses: - "200": - description: create されたbudgetが返ってくる - content: {} - /budgets/details: - get: - tags: - - budget - description: budgetに紐づくyearとsourceの一覧を取得 - responses: - "200": - description: budgetに紐づくyearとsourceの一覧を取得 - content: {} - /budgets/details/{year}: - get: - tags: - - budget - description: 年度で指定されたbudgetsに紐づく年度とソースを取得 - parameters: - - name: year - in: path - description: year - required: true - schema: - type: integer - responses: - "200": - description: 年度で指定されたbudgetsに紐づく年度とソースを取得 - content: {} - /budgets/{id}: - get: - tags: - - budget - description: IDで指定されたbudgetの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: budgetの取得 - content: {} - put: - tags: - - budget - description: budgetの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - - name: price - in: query - description: price - schema: - type: integer - - name: year_id - in: query - description: year_id - schema: - type: integer - - name: source_id - in: query - description: source_id - schema: - type: integer - responses: - "200": - description: 更新されたbudgetが返ってくる - content: {} - delete: - tags: - - budget - description: IDを指定してbudgetの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: budgetの削除完了 - content: {} - /budgets/{id}/details: - get: - tags: - - budget - description: IDで指定されたbudgetに紐づくyearとsourceを取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: budgetに紐づくyearとsourceを取得 - content: {} - /bureaus: - get: - tags: - - bureau - description: bureauの一覧を取得 - responses: - "200": - description: bureauの一覧の取得 - content: {} - post: - tags: - - bureau - description: bureauの作成 - parameters: - - name: name - in: query - description: name - required: true - schema: - type: string - responses: - "200": - description: create されたbureauが返ってくる - content: {} - /bureaus/{id}: - get: - tags: - - bureau - description: IDで指定されたbureauの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: bureauの取得 - content: {} - put: - tags: - - bureau - description: bureauの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - - name: name - in: query - description: name - schema: - type: string - responses: - "200": - description: 更新されたbureauが返ってくる - content: {} - delete: - tags: - - bureau - description: IDを指定してbureauの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: bureauの削除完了 - content: {} - /departments: - get: - tags: - - department - description: departmentの一覧の取得 - responses: - "200": - description: departmentの一覧を取得 - content: {} - post: - tags: - - department - description: departmentの作成 - parameters: - - name: name - in: query - description: name - schema: - type: string - responses: - "200": - description: 作成されたdepartmentが返ってくる - content: {} - /departments/{id}: - get: - tags: - - department - description: IDで指定されたdepartmentの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: departmentの取得 - content: {} - put: - tags: - - department - description: departmentの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - - name: name - in: query - description: name - schema: - type: string - responses: - "200": - description: 更新されたdepartmentが返ってくる - content: {} - delete: - tags: - - department - description: IDを指定してdepartmentの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: departmentの削除完了 - content: {} - /expenses: - get: - tags: - - expense - description: expenseの一覧の取得 - responses: - "200": - description: expenseの一覧を取得 - content: {} - post: - tags: - - expense - description: expenseの作成 - parameters: - - name: name - in: query - description: name - schema: - type: string - - name: year_id - in: query - description: year_id - schema: - type: string - responses: - "200": - description: 作成されたexpenseが返ってくる - content: {} - /expenses/details: - get: - tags: - - expense - description: expenseに紐づくpurchase_itemの一覧を取得 - responses: - "200": - description: expenseに紐づくpurchase_itemの一覧を取得 - content: {} - /expenses/{id}: - get: - tags: - - expense - description: IDで指定されたexpenseの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: expenseの取得 - content: {} - put: - tags: - - expense - description: expenseの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - - name: name - in: query - description: name - schema: - type: string - - name: year_id - in: query - description: year_id - schema: - type: string - responses: - "200": - description: 更新されたexpenseが返ってくる - content: {} - delete: - tags: - - expense - description: IDを指定してexpenseの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: expenseの削除完了 - content: {} - /expenses/{id}/details: - get: - tags: - - expense - description: IDで指定されたexpenseに紐づくpurchase_itemsを取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: IDで指定されたexpenseに紐づくpurchase_itemsを取得 - content: {} - /expenses/details/{year}: - get: - tags: - - expense - description: 年度で指定されたexpenseに紐づく購入申請と購入報告を取得 - parameters: - - name: year - in: path - description: year - required: true - schema: - type: integer - responses: - "200": - description: yearで指定されたexpenseに紐づく購入申請と購入報告を取得 - content: {} - /expenses/fiscalyear/{year}: - get: - tags: - - expense - description: 年度で指定されたexpensesを取得 - parameters: - - name: year - in: path - description: year - required: true - schema: - type: integer - responses: - "200": - description: yearで指定されたexpensesを取得 - content: {} - /fund_informations: - get: - tags: - - fund_information - description: fund_informationの一覧を取得 - responses: - "200": - description: fund_informationの一覧の取得 - content: {} - post: - tags: - - fund_information - description: fund_informationの作成 - parameters: - - name: user_id - in: query - description: user_id - required: true - schema: - type: integer - - name: teacher_id - in: query - description: teacher_id - required: true - schema: - type: integer - - name: price - in: query - description: price - required: true - schema: - type: integer - - name: remark - in: query - description: remark - schema: - type: string - - name: is_first_check - in: query - description: is_first_check - schema: - type: boolean - - name: is_last_check - in: query - description: is_last_check - schema: - type: boolean - - name: received_at - in: query - description: received_at - schema: - type: string - responses: - "200": - description: create されたfund_informationが返ってくる - content: {} - /fund_informations/details: - get: - tags: - - fund_information - description: fund_informationに紐づくteacherとuserの一覧を取得 - responses: - "200": - description: fund_informationに紐づくteacherとuserの一覧を取得 - content: {} - /fund_informations/{id}: - get: - tags: - - fund_information - description: IDで指定されたfund_informationの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: fund_informationの取得 - content: {} - put: - tags: - - fund_information - description: fund_informationの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - - name: user_id - in: query - description: user_id - required: true - schema: - type: integer - - name: teacher_id - in: query - description: teacher_id - required: true - schema: - type: integer - - name: price - in: query - description: price - required: true - schema: - type: integer - - name: remark - in: query - description: remark - schema: - type: string - - name: is_first_check - in: query - description: is_first_check - schema: - type: boolean - - name: is_last_check - in: query - description: is_last_check - schema: - type: boolean - - name: received_at - in: query - description: received_at - schema: - type: string - responses: - "200": - description: 更新されたfund_informationが返ってくる - content: {} - delete: - tags: - - fund_information - description: IDを指定してfund_informationの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: fund_informationの削除完了 - content: {} - /fund_informations/{id}/details: - get: - tags: - - fund_information - description: IDで指定されたfund_informatinに紐づくteacherとuserを取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: fund_informatinに紐づくteacherとuserを取得 - content: {} - /fund_informations/details/{year}: - get: - tags: - - fund_information - description: 年度で指定されたfund_informationsに紐づくデータを取得 - parameters: - - name: year - in: path - description: year - required: true - schema: - type: integer - responses: - "200": - description: 年度で指定されたfund_informationsに紐づくデータを取得 - content: {} - /password_reset/{id}: - post: - tags: - - password_reset - description: password_変更 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/passwordResetData" - required: false - responses: - "200": - description: passwordを変更する - content: {} - x-codegen-request-body-name: passwordResetData - /password_reset/request: - post: - tags: - - password_reset - description: password_reset_token発行リクエスト - parameters: - - name: email - in: query - description: email - schema: - type: string - responses: - "200": - description: password_reset_tokenをメールアドレスに送信する - content: {} - /password_reset/{id}/valid: - post: - tags: - - password_reset - description: トークンの称号 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - - name: token - in: query - description: token - schema: - type: string - responses: - "200": - description: password_reset_tokenが正しい確認する - content: {} - /purchaseitems: - get: - tags: - - purchase_item - description: purchase_itemの一覧を取得 - responses: - "200": - description: purchase_itemの一覧の取得 - content: {} - post: - tags: - - purchase_item - description: purchase_itemの作成 - parameters: - - name: item - in: query - description: item - schema: - type: string - - name: price - in: query - description: price - schema: - type: integer - - name: quantity - in: query - description: quantity - schema: - type: integer - - name: detail - in: query - description: detail - schema: - type: string - - name: url - in: query - description: url - schema: - type: string - - name: purchase_order_id - in: query - description: purchase_order_id - schema: - type: integer - - name: finance_check - in: query - description: finance_check - schema: - type: boolean - responses: - "200": - description: createされたpurchase_itemが返ってくる - content: {} - /purchaseitems/details: - get: - tags: - - purchase_item - description: purchase_itemに紐づくuserとpurchase_orderの一覧を取得 - responses: - "200": - description: purchase_itemに紐づくuserとpurchase_orderの一覧を取得 - content: {} - /purchaseitems/{id}: - get: - tags: - - purchase_item - description: IDで指定されたpurchase_itemの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: purchase_itemの取得 - content: {} - put: - tags: - - purchase_item - description: purchase_itemの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - - name: item - in: query - description: item - schema: - type: string - - name: price - in: query - description: price - schema: - type: integer - - name: quantity - in: query - description: quantity - schema: - type: integer - - name: detail - in: query - description: detail - schema: - type: string - - name: url - in: query - description: url - schema: - type: string - - name: purchase_order_id - in: query - description: purchase_order_id - schema: - type: integer - - name: finance_check - in: query - description: finance_check - schema: - type: boolean - responses: - "200": - description: 更新されたpurchase_itemが返ってくる - content: {} - delete: - tags: - - purchase_item - description: IDを指定してpurchase_itemの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: purchase_itemの削除完了 - content: {} - /purchaseitems/{id}/details: - get: - tags: - - purchase_item - description: IDで指定されたpurchase_itemに紐づくuserとpurchase_orderを取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: IDで指定されたpurchase_itemに紐づくuserとpurchase_orderを取得 - content: {} - /purchaseorders: - get: - tags: - - purchase_order - description: purchase_orderの一覧を取得 - responses: - "200": - description: purchase_orderの一覧の取得 - content: {} - post: - tags: - - purchase_order - description: purchase_orderの作成 - parameters: - - name: deadline - in: query - description: deadline - schema: - type: string - - name: user_id - in: query - description: user_id - schema: - type: integer - - name: expense_id - in: query - description: expense_id - schema: - type: integer - - name: finance_check - in: query - description: finance_check - schema: - type: boolean - responses: - "200": - description: createされたpurchase_orderが返ってくる - content: {} - /purchaseorders/details: - get: - tags: - - purchase_order - description: purchaseorderに紐づくuserとitemの一覧を取得 - responses: - "200": - description: purchase_orderに紐づくuserとpurchase_itemの一覧を取得 - content: {} - /purchaseorders/{id}: - get: - tags: - - purchase_order - description: IDで指定されたpurchase_orderの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: purchase_orderの取得 - content: {} - put: - tags: - - purchase_order - description: purchase_orderの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - - name: deadline - in: query - description: deadline - schema: - type: string - - name: user_id - in: query - description: user_id - schema: - type: integer - - name: expense_id - in: query - description: expense_id - schema: - type: integer - - name: finance_check - in: query - description: finance_check - schema: - type: boolean - responses: - "200": - description: 更新されたpurchase_orderが返ってくる - content: {} - delete: - tags: - - purchase_order - description: IDを指定してpurchase_orderの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: purchase_orderの削除完了 - content: {} - /purchaseorders/{id}/details: - get: - tags: - - purchase_order - description: IDで指定されたpurchase_orderに紐づくuserとpurchase_itemを取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: IDで指定されたpurchase_orderに紐づくuserとpurchase_itemを取得 - content: {} - /purchaseorders/details/{year}: - get: - tags: - - purchase_order - description: 年度で指定されたpurchase_orderに紐づくuserとpurchase_itemを取得 - parameters: - - name: year - in: path - description: year - required: true - schema: - type: integer - responses: - "200": - description: IDで指定されたpurchase_orderに紐づくuserとpurchase_itemを取得 - content: {} - /purchaseorders/send/{id}: - post: - tags: - - purchase_order - description: IDで指定されたpurchase_orderのslackへメッセージ送信 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - requestBody: - content: - "*/*": - schema: - type: array - items: - $ref: "#/components/schemas/purchaseItem" - required: true - responses: - "200": - description: IDで指定されたpurchase_orderに紐づくuserとpurchase_itemを取得 - content: {} - x-codegen-request-body-name: purchase_items - /purchaseorders/details/unregistered/{year}: - get: - tags: - - purchase_order - description: 年度で指定されたreportsに未登録のpurchase_orderに紐づくuserとpurchase_itemを取得 - parameters: - - name: year - in: path - description: year - required: true - schema: - type: integer - responses: - "200": - description: IDで指定されたreportsに未登録のpurchase_orderに紐づくuserとpurchase_itemを取得 - content: {} - /purchasereports: - get: - tags: - - purchase_report - description: purchase_reportの一覧を取得 - responses: - "200": - description: purchase_reportの一覧の取得 - content: {} - post: - tags: - - purchase_report - description: purchase_reportの作成 - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/purchaseReport" - required: false - responses: - "200": - description: 作成されたpurchaseReportが返ってくる - content: {} - x-codegen-request-body-name: purchaseReport - /purchasereports/details: - get: - tags: - - purchase_report - description: purchasereportsに紐づくデータの一覧を取得 - responses: - "200": - description: purchase_reportに紐づくデータの一覧を取得 - content: {} - /purchasereports/{id}: - get: - tags: - - purchase_report - description: IDで指定されたpurchase_reportの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: purchase_reportの取得 - content: {} - put: - tags: - - purchase_report - description: purchase_reportの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/purchaseReport" - required: false - responses: - "200": - description: 更新されたpurchase_reportが返ってくる - content: {} - x-codegen-request-body-name: purchaseReport - delete: - tags: - - purchase_report - description: IDを指定してpurchase_reportの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: purchase_reportの削除完了 - content: {} - /purchasereports/{id}/details: - get: - tags: - - purchase_report - description: IDで指定されたpurchase_reportに紐づくデータを取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: IDで指定されたpurchase_reportに紐づくデータを取得 - content: {} - /purchasereports/details/{year}: - get: - tags: - - purchase_report - description: 年度で指定されたpurchase_reportsに紐づくデータを取得 - parameters: - - name: year - in: path - description: year - required: true - schema: - type: integer - responses: - "200": - description: 年度で指定されたpurchase_reportsに紐づくデータを取得 - content: {} - /receipts: - get: - tags: - - receipt - description: receiptの一覧を取得 - responses: - "200": - description: receiptの一覧の取得 - content: {} - post: - tags: - - receipt - description: receiptの作成 - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/receipt" - required: false - responses: - "200": - description: create されたreceiptが返ってくる - content: {} - x-codegen-request-body-name: receipt - /receipts/{id}: - get: - tags: - - receipt - description: IDで指定されたreceiptの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: receiptの取得 - content: {} - put: - tags: - - receipt - description: receiptの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/receipt" - required: false - responses: - "200": - description: 更新されたreceiptが返ってくる - content: {} - x-codegen-request-body-name: receipt - delete: - tags: - - receipt - description: IDを指定してreceiptの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: receiptの削除完了 - content: {} - /receipts/reports/{id}: - get: - tags: - - receipt - description: purchaseReportIDで指定されたreceiptの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: reportsIDを指定してreceiptの取得 - content: {} - /sources: - get: - tags: - - source - description: sourceの一覧の取得 - responses: - "200": - description: sourceの一覧を取得 - content: {} - post: - tags: - - source - description: sourceの作成 - parameters: - - name: name - in: query - description: name - required: true - schema: - type: string - responses: - "200": - description: 作成されたsourceが返ってくる - content: {} - /sources/{id}: - get: - tags: - - source - description: IDで指定されたsourceの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: sourceの取得 - content: {} - put: - tags: - - source - description: sourceの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - - name: name - in: query - description: name - required: true - schema: - type: string - responses: - "200": - description: 更新されたsourceが返ってくる - content: {} - delete: - tags: - - source - description: IDを指定してsourceの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: sourceの削除完了 - content: {} - /sponsors: - get: - tags: - - sponsor - description: sponsorの一覧の取得 - responses: - "200": - description: sponsorsの一覧を取得 - content: {} - post: - tags: - - sponsor - description: sponsorの作成 - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/sponsor" - required: false - responses: - "200": - description: 作成されたsponsorが返ってくる - content: {} - x-codegen-request-body-name: sponsor - /sponsors/{id}: - get: - tags: - - sponsor - description: IDで指定されたsponsorの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: sponsorの取得 - content: {} - put: - tags: - - sponsor - description: sponsorの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/sponsor" - required: false - responses: - "200": - description: 更新されたsponsorが返ってくる - content: {} - x-codegen-request-body-name: sponsor - delete: - tags: - - sponsor - description: IDを指定してsponsorの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: sponsorの削除完了 - content: {} - /sponsors/periods/{year}: - get: - tags: - - sponsor - description: 年度で指定されたsponsorを取得 - parameters: - - name: year - in: path - description: year - required: true - schema: - type: integer - responses: - "200": - description: sponsorの取得完了 - content: {} - /sponsorstyles: - get: - tags: - - sponsorstyle - description: sponsorstyleの一覧の取得 - responses: - "200": - description: sponsorstyleの一覧を取得 - content: {} - post: - tags: - - sponsorstyle - description: sponsorstyleの作成 - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/sponsorStyle" - required: false - responses: - "200": - description: 作成されたsponsorstyleが返ってくる - content: {} - x-codegen-request-body-name: sponsorStyle - /sponsorstyles/{id}: - get: - tags: - - sponsorstyle - description: IDで指定されたsponsorstyleの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: sponsorstyleの取得 - content: {} - put: - tags: - - sponsorstyle - description: sponsorstyleの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/sponsorStyle" - required: false - responses: - "200": - description: 更新されたsponsorstyleが返ってくる - content: {} - x-codegen-request-body-name: sponsorStyle - delete: - tags: - - sponsorstyle - description: IDを指定してsponsorstyleの論理削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: sponsorstyleの論理削除完了 - content: {} - /teachers: - get: - tags: - - teacher - description: teacherの一覧を取得 - responses: - "200": - description: teacherの一覧を取得 - content: - "*/*": - schema: - type: array - post: - tags: - - teacher - description: teacherの作成 - parameters: - - name: name - in: query - description: 名前 - required: true - schema: - type: string - - name: position - in: query - description: 役職 - required: true - schema: - type: string - - name: department_id - in: query - description: 学科ID - schema: - type: integer - - name: room - in: query - description: 部屋番号 - schema: - type: string - - name: is_black - in: query - description: ブラックリストの真偽 - schema: - type: boolean - - name: remark - in: query - description: 備考 - schema: - type: string - responses: - "200": - description: createされたteacherが返ってくる - content: {} - /teachers/delete: - delete: - tags: - - teacher - description: teacherの複数削除 - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/destroyTeacherIDs" - required: false - responses: - "200": - description: 複数のteacherをidで削除できる - content: {} - x-codegen-request-body-name: destroyTeacherIDs - /teachers/{id}: - get: - tags: - - teacher - description: IDで指定されたteacherの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: teacherの取得 - content: {} - put: - tags: - - teacher - description: teacherの更新 - parameters: - - name: id - in: path - description: Teacherのid - required: true - schema: - type: integer - - name: name - in: query - description: 教員の名前 - required: true - schema: - type: string - - name: position - in: query - description: 教員の役職 - required: true - schema: - type: string - - name: department_id - in: query - description: 学科ID - schema: - type: integer - - name: room - in: query - description: 部屋番号 - schema: - type: string - - name: is_black - in: query - description: ブラックリストに入っているか - schema: - type: boolean - - name: remark - in: query - description: 備考欄 - schema: - type: string - responses: - "200": - description: 更新されたteacherが返ってくる - content: {} - delete: - tags: - - teacher - description: IDを指定してteacherの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: teacherの削除完了 - content: {} - /teachers/fundRegistered/{year}: - get: - tags: - - teacher - description: 募金登録済みのteacherのidを取得 - parameters: - - name: year - in: path - description: year - required: true - schema: - type: integer - responses: - "200": - description: 募金登録済みのteacherのidを取得 - content: {} - /users: - get: - tags: - - user - description: userの一覧を取得 - responses: - "200": - description: userの一覧を取得 - content: - "*/*": - schema: - type: array - post: - tags: - - user - description: userの作成 - parameters: - - name: name - in: query - description: name - required: true - schema: - type: string - - name: bureau_id - in: query - description: bureau_d - required: true - schema: - type: integer - - name: role_id - in: query - description: role_id - required: true - schema: - type: integer - responses: - "200": - description: createされたuserが返ってくる - content: {} - /users/delete: - delete: - tags: - - user - description: userの複数作成 - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/destroyUserIDs" - required: false - responses: - "200": - description: 複数のuserをidで削除できる - content: {} - x-codegen-request-body-name: destroyUserIDs - /users/{id}: - get: - tags: - - user - description: IDで指定されたuserの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: userの取得 - content: {} - put: - tags: - - user - description: userの更新 - parameters: - - name: id - in: path - description: userのid - required: true - schema: - type: integer - - name: name - in: query - description: name - required: true - schema: - type: string - - name: bureau_id - in: query - description: bureau_d - required: true - schema: - type: integer - - name: role_id - in: query - description: role_id - required: true - schema: - type: integer - responses: - "200": - description: 更新されたuserが返ってくる - content: {} - delete: - tags: - - user - description: IDを指定してuserの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: userの削除完了 - content: {} - /years: - get: - tags: - - year - description: yearの一覧の取得 - responses: - "200": - description: yearの一覧を取得 - content: {} - post: - tags: - - year - description: yearの作成 - parameters: - - name: year - in: query - description: year - required: true - schema: - type: integer - responses: - "200": - description: 作成されたyearが返ってくる - content: {} - /years/{id}: - get: - tags: - - year - description: IDで指定されたyearの取得 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: yearの取得 - content: {} - put: - tags: - - year - description: yearの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - - name: year - in: query - description: year - required: true - schema: - type: integer - responses: - "200": - description: 更新されたyearが返ってくる - content: {} - delete: - tags: - - year - description: IDを指定してyearの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: yearの削除完了 - content: {} - /years/periods: - get: - tags: - - year_periods - description: 年度一覧の取得 - responses: - "200": - description: year_periodsの一覧を取得 - content: {} - post: - tags: - - year_periods - description: year_periodsの作成 - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/year_periods" - required: false - responses: - "200": - description: 作成されたyear_periodsが返ってくる - content: {} - x-codegen-request-body-name: year_periods - /years/periods/{id}: - put: - tags: - - year_periods - description: year_periodsの更新 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - requestBody: - content: - "*/*": - schema: - $ref: "#/components/schemas/year_periods" - required: false - responses: - "200": - description: 更新されたyear_periodsが返ってくる - content: {} - x-codegen-request-body-name: year_periods - delete: - tags: - - year_periods - description: IDを指定してyear_periodsの削除 - parameters: - - name: id - in: path - description: id - required: true - schema: - type: integer - responses: - "200": - description: year_periodsの削除完了 - content: {} -components: - schemas: - activity: - required: - - expense - - feature - - isDone - - remark - - sponsorID - - userID - type: object - properties: - sponsorID: - type: integer - example: 1 - userID: - type: integer - example: 1 - isDone: - type: boolean - example: false - feature: - type: string - example: なし - expense: - type: integer - example: 0 - remark: - type: string - example: なし - design: - type: integer - example: 0 - url: - type: string - example: "" - activity_information: - type: object - properties: - activityID: - type: integer - example: 1 - bucketName: - type: string - example: なし - fileName: - type: string - example: なし - fileType: - type: string - example: なし - designProgress: - type: integer - example: 1 - fileInformation: - type: string - example: "" - activity_style: - required: - - activityID - - sponsorStyleID - type: object - properties: - activityID: - type: integer - example: 1 - sponsorStyleID: - type: integer - example: 1 - sponsorStyle: - required: - - feature - - price - - style - type: object - properties: - style: - type: string - example: 1分の1 - feature: - type: string - example: カラー - price: - type: integer - example: 30000 - sponsor: - required: - - address - - email - - name - - representative - - tel - type: object - properties: - name: - type: string - example: 企業1 - tel: - type: string - example: "09000000000" - email: - type: string - example: test@example.com - address: - type: string - example: ○○1-1 - representative: - type: string - example: 長岡太郎(社長) - passwordResetData: - type: object - properties: - token: - type: string - example: "" - password: - type: string - example: "" - confirmPassword: - type: string - example: "" - purchaseReport: - required: - - addition - - discount - - financeCheck - - purchaseOrderID - - userID - type: object - properties: - userID: - type: integer - example: 1 - discount: - type: integer - example: 0 - addition: - type: integer - example: 0 - financeCheck: - type: boolean - example: false - purchaseOrderID: - type: integer - example: 1 - remark: - type: string - example: "" - buyer: - type: string - example: "" - purchaseItem: - required: - - financeCheck - - item - - price - - purchaseOrderID - - quantity - type: object - properties: - item: - type: string - example: name - price: - type: integer - example: 0 - quantity: - type: integer - example: 0 - detail: - type: string - example: "" - url: - type: string - example: "" - purchaseOrderID: - type: integer - example: 1 - financeCheck: - type: boolean - example: false - destroyTeacherIDs: - required: - - deleteIDs - type: object - properties: - deleteIDs: - type: array - example: [] - items: - type: number - destroyUserIDs: - required: - - deleteIDs - type: object - properties: - deleteIDs: - type: array - example: [] - items: - type: number - receipt: - required: - - purchaseReportID - type: object - properties: - purchaseReportID: - type: integer - example: 1 - bucketName: - type: string - example: "" - fileName: - type: string - example: "" - fileType: - type: string - example: "" - remark: - type: string - example: "" - year_periods: - required: - - endedAt - - startedAt - - year - type: object - properties: - year: - type: integer - example: 2024 - startedAt: - type: string - example: 0000-00-00T00:00:00Z - endedAt: - type: string - example: 0000-00-00T00:00:00Z -x-original-swagger-version: "2.0"