Skip to content

Commit ca59867

Browse files
sakakibara-setusakakibara-setu
authored
Merge pull request #523 from freee/feature/update_schema_files_2025-12-01-05-05
Update schema files
2 parents 4619ce7 + eb32572 commit ca59867

File tree

1 file changed

+251
-16
lines changed

1 file changed

+251
-16
lines changed

‎hr/open-api-3/api-schema.json‎

Lines changed: 251 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4681,6 +4681,145 @@
46814681
}
46824682
}
46834683
},
4684+
"/api/v1/employees/{employee_id}/group_memberships": {
4685+
"get": {
4686+
"tags": [
4687+
"所属"
4688+
],
4689+
"summary": "従業員の所属取得",
4690+
"description": "<h2 id=\"\">概要</h2>\n<p>指定した従業員の所属情報をリストで返します。</p>\n<p>base_dateを指定した場合は指定日付時点の所属情報を、base_dateを省略した場合は全期間の所属履歴を返します。</p>\n\n<h2 id=\"_1\">注意点</h2>\n<ul>\n <li>管理者権限を持ったユーザーのみ実行可能です。</li>\n</ul>",
4691+
"operationId": "get_employee_group_memberships_by_employee_id",
4692+
"parameters": [
4693+
{
4694+
"name": "employee_id",
4695+
"in": "path",
4696+
"required": true,
4697+
"schema": {
4698+
"type": "integer",
4699+
"minimum": 1,
4700+
"maximum": 2147483647
4701+
},
4702+
"example": 1,
4703+
"description": "従業員ID"
4704+
},
4705+
{
4706+
"name": "company_id",
4707+
"in": "query",
4708+
"required": true,
4709+
"schema": {
4710+
"type": "integer",
4711+
"minimum": 1,
4712+
"maximum": 2147483647
4713+
},
4714+
"example": 1,
4715+
"description": "事業所ID"
4716+
},
4717+
{
4718+
"name": "base_date",
4719+
"in": "query",
4720+
"required": false,
4721+
"schema": {
4722+
"type": "string",
4723+
"format": "date",
4724+
"pattern": "^[0-9]{4}-[0-9]{2}-[0-9]{2}$"
4725+
},
4726+
"description": "指定日。指定日付時点における所属情報を返します。(YYYY-MM-DD)(例:2018-07-31)\n省略した場合は全期間の所属履歴を返します。\n",
4727+
"example": "2018-07-31"
4728+
},
4729+
{
4730+
"name": "limit",
4731+
"in": "query",
4732+
"required": false,
4733+
"description": "取得レコードの件数 (デフォルト: 50, 最小: 1, 最大: 100)",
4734+
"schema": {
4735+
"type": "integer",
4736+
"minimum": 1,
4737+
"maximum": 100,
4738+
"example": 50
4739+
}
4740+
},
4741+
{
4742+
"name": "offset",
4743+
"in": "query",
4744+
"required": false,
4745+
"description": "取得レコードのオフセット (デフォルト: 0)",
4746+
"schema": {
4747+
"type": "integer",
4748+
"minimum": 0,
4749+
"maximum": 2147483647,
4750+
"example": 0
4751+
}
4752+
}
4753+
],
4754+
"responses": {
4755+
"200": {
4756+
"description": "successful operation",
4757+
"content": {
4758+
"application/json": {
4759+
"schema": {
4760+
"$ref": "#/components/schemas/ApiV1EmployeesGroupMembershipsIndexSerializer"
4761+
}
4762+
}
4763+
}
4764+
},
4765+
"400": {
4766+
"description": "",
4767+
"content": {
4768+
"application/problem+json": {
4769+
"schema": {
4770+
"$ref": "#/components/schemas/error"
4771+
}
4772+
}
4773+
}
4774+
},
4775+
"401": {
4776+
"description": "",
4777+
"content": {
4778+
"application/json": {
4779+
"schema": {
4780+
"$ref": "#/components/schemas/unauthorizedError"
4781+
}
4782+
}
4783+
}
4784+
},
4785+
"403": {
4786+
"description": "",
4787+
"content": {
4788+
"application/problem+json": {
4789+
"schema": {
4790+
"$ref": "#/components/schemas/forbiddenError"
4791+
}
4792+
},
4793+
"application/json": {
4794+
"schema": {
4795+
"$ref": "#/components/schemas/accessDeniedError"
4796+
}
4797+
}
4798+
}
4799+
},
4800+
"404": {
4801+
"description": "",
4802+
"content": {
4803+
"application/problem+json": {
4804+
"schema": {
4805+
"$ref": "#/components/schemas/notfoundError"
4806+
}
4807+
}
4808+
}
4809+
},
4810+
"500": {
4811+
"description": "",
4812+
"content": {
4813+
"application/problem+json": {
4814+
"schema": {
4815+
"$ref": "#/components/schemas/internalServerError"
4816+
}
4817+
}
4818+
}
4819+
}
4820+
}
4821+
}
4822+
},
46844823
"/api/v1/groups": {
46854824
"get": {
46864825
"tags": [
@@ -11162,7 +11301,6 @@
1116211301
},
1116311302
"employee_num": {
1116411303
"type": "string",
11165-
"nullable": true,
1116611304
"description": "従業員番号"
1116711305
},
1116811306
"pay_date": {
@@ -11611,7 +11749,6 @@
1161111749
"num": {
1161211750
"type": "string",
1161311751
"description": "従業員番号",
11614-
"nullable": true,
1161511752
"example": "A-001"
1161611753
},
1161711754
"display_name": {
@@ -12849,8 +12986,7 @@
1284912986
},
1285012987
"num": {
1285112988
"type": "string",
12852-
"description": "従業員番号",
12853-
"nullable": true
12989+
"description": "従業員番号"
1285412990
},
1285512991
"display_name": {
1285612992
"type": "string",
@@ -13033,8 +13169,7 @@
1303313169
},
1303413170
"employee_num": {
1303513171
"type": "string",
13036-
"description": "従業員番号",
13037-
"nullable": true
13172+
"description": "従業員番号"
1303813173
},
1303913174
"closing_date": {
1304013175
"type": "string",
@@ -13120,8 +13255,7 @@
1312013255
},
1312113256
"num": {
1312213257
"type": "string",
13123-
"description": "従業員番号(従業員詳細未設定の場合、nullになります。)",
13124-
"nullable": true
13258+
"description": "従業員番号"
1312513259
},
1312613260
"display_name": {
1312713261
"type": "string",
@@ -18272,8 +18406,7 @@
1827218406
},
1827318407
"num": {
1827418408
"type": "string",
18275-
"description": "従業員番号",
18276-
"nullable": true
18409+
"description": "従業員番号"
1827718410
},
1827818411
"employee_display_name": {
1827918412
"type": "string",
@@ -18426,15 +18559,15 @@
1842618559
"type": "integer",
1842718560
"description": "その他の事業所の給与収入",
1842818561
"example": 1000000,
18429-
"minimum": 0,
18562+
"minimum": -999999999,
1843018563
"maximum": 1999999999,
1843118564
"nullable": true
1843218565
},
1843318566
"all_other_income": {
1843418567
"type": "integer",
1843518568
"description": "給与以外の所得",
1843618569
"example": 1000000,
18437-
"minimum": 0,
18570+
"minimum": -999999999,
1843818571
"maximum": 1999999999,
1843918572
"nullable": true
1844018573
},
@@ -18489,8 +18622,7 @@
1848918622
"num": {
1849018623
"type": "string",
1849118624
"description": "従業員番号<br>\n従業員を判別しやすいよう管理することができます。（例: 1人目の正社員を A-001 と入力）",
18492-
"example": "A-001",
18493-
"nullable": true
18625+
"example": "A-001"
1849418626
},
1849518627
"last_name": {
1849618628
"type": "string",
@@ -19023,14 +19155,14 @@
1902319155
"type": "integer",
1902419156
"description": "給与収入 配偶者は「扶養状況」がsocial_insurance_and_tax又はtax_onlyの場合のみ更新可能。配偶者以外は更新不可。更新不可の場合は0となります。",
1902519157
"format": "int32",
19026-
"minimum": 0,
19158+
"minimum": -999999999,
1902719159
"maximum": 999999999
1902819160
},
1902919161
"all_other_income": {
1903019162
"type": "integer",
1903119163
"description": "給与以外の所得 配偶者は「扶養状況」がsocial_insurance_and_tax又はtax_onlyの場合のみ更新可能。配偶者以外は更新不可。更新不可の場合は0となります。",
1903219164
"format": "int32",
19033-
"minimum": 0,
19165+
"minimum": -999999999,
1903419166
"maximum": 999999999
1903519167
},
1903619168
"disability_type": {
@@ -20459,6 +20591,109 @@
2045920591
}
2046020592
}
2046120593
},
20594+
"ApiV1EmployeesGroupMembershipsIndexSerializer": {
20595+
"type": "object",
20596+
"required": [
20597+
"group_memberships",
20598+
"total_count"
20599+
],
20600+
"properties": {
20601+
"group_memberships": {
20602+
"type": "array",
20603+
"items": {
20604+
"type": "object",
20605+
"required": [
20606+
"id",
20607+
"start_date",
20608+
"end_date",
20609+
"main_duty",
20610+
"group_id",
20611+
"group_code",
20612+
"group_name"
20613+
],
20614+
"properties": {
20615+
"id": {
20616+
"type": "integer",
20617+
"description": "グループ所属ID",
20618+
"format": "int64",
20619+
"example": 1
20620+
},
20621+
"start_date": {
20622+
"type": "string",
20623+
"description": "開始日",
20624+
"format": "date",
20625+
"example": "2000-01-01"
20626+
},
20627+
"end_date": {
20628+
"type": "string",
20629+
"description": "終了日",
20630+
"format": "date",
20631+
"nullable": true,
20632+
"example": "2020-01-01"
20633+
},
20634+
"boss_id": {
20635+
"type": "integer",
20636+
"description": "上司ID",
20637+
"format": "int64",
20638+
"nullable": true,
20639+
"example": 1
20640+
},
20641+
"main_duty": {
20642+
"type": "string",
20643+
"enum": [
20644+
"unspecified",
20645+
"sub_duty",
20646+
"main_duty"
20647+
],
20648+
"description": "主務",
20649+
"example": "main_duty"
20650+
},
20651+
"group_id": {
20652+
"type": "integer",
20653+
"description": "部門ID",
20654+
"format": "int32",
20655+
"example": 10
20656+
},
20657+
"group_code": {
20658+
"type": "string",
20659+
"description": "部門コード",
20660+
"example": "group2"
20661+
},
20662+
"group_name": {
20663+
"type": "string",
20664+
"description": "部門名称",
20665+
"example": "営業部"
20666+
},
20667+
"position_id": {
20668+
"type": "integer",
20669+
"description": "役職ID",
20670+
"format": "int32",
20671+
"nullable": true,
20672+
"example": 1
20673+
},
20674+
"position_code": {
20675+
"type": "string",
20676+
"description": "役職コード",
20677+
"nullable": true,
20678+
"example": "position1"
20679+
},
20680+
"position_name": {
20681+
"type": "string",
20682+
"description": "役職名称",
20683+
"nullable": true,
20684+
"example": "部長"
20685+
}
20686+
}
20687+
}
20688+
},
20689+
"total_count": {
20690+
"type": "integer",
20691+
"description": "合計件数",
20692+
"format": "int32",
20693+
"example": 1
20694+
}
20695+
}
20696+
},
2046220697
"error": {
2046320698
"type": "object",
2046420699
"properties": {

0 commit comments

Comments
 (0)