@tocca-systems/twp-cli 0.14.1 → 0.15.0

package/command-model/policy.json

@@ -0,0 +1,506 @@
+{
+  "domain": "policy",
+  "operations": [
+    {
+      "name": "categories",
+      "domain": "policy",
+      "operationId": "policy.categories",
+      "method": "GET",
+      "path": "/v2/policies/categories",
+      "summary": "分類の選択肢（FEのセレクトボックス用）。",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "categories",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "create",
+      "domain": "policy",
+      "operationId": "policy.store",
+      "method": "POST",
+      "path": "/v2/policies",
+      "summary": "",
+      "pathParams": [],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "category": {
+              "type": "string",
+              "enum": [
+                "work_rules",
+                "leave_and_duty",
+                "allowance_and_expense",
+                "supplementary_provisions",
+                "information_security",
+                "article36_agreement",
+                "labor_agreement"
+              ]
+            },
+            "title": {
+              "type": "string",
+              "maxLength": 255
+            }
+          },
+          "required": [
+            "category",
+            "title"
+          ],
+          "title": "StorePolicyRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "delete",
+      "domain": "policy",
+      "operationId": "policy.destroy",
+      "method": "DELETE",
+      "path": "/v2/policies/{policyId}",
+      "summary": "",
+      "pathParams": [
+        {
+          "name": "policyId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "destroy-version",
+      "domain": "policy",
+      "operationId": "policy.destroyVersion",
+      "method": "DELETE",
+      "path": "/v2/policies/{policyId}/versions/{versionId}",
+      "summary": "",
+      "pathParams": [
+        {
+          "name": "policyId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "versionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": null,
+      "resultPath": null,
+      "risk": "destructive",
+      "aliases": []
+    },
+    {
+      "name": "get",
+      "domain": "policy",
+      "operationId": "policy.show",
+      "method": "GET",
+      "path": "/v2/policies/{policyId}",
+      "summary": "規程詳細。",
+      "pathParams": [
+        {
+          "name": "policyId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": null,
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "list",
+      "domain": "policy",
+      "operationId": "policy.index",
+      "method": "GET",
+      "path": "/v2/policies",
+      "summary": "規程一覧（版・公開対象を含む）。",
+      "pathParams": [],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "policies",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "set-targets",
+      "domain": "policy",
+      "operationId": "policy.setTargets",
+      "method": "PUT",
+      "path": "/v2/policies/{policyId}/targets",
+      "summary": "公開対象を洗い替える（PUT セマンティクス）。",
+      "pathParams": [
+        {
+          "name": "policyId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "targets": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "target_type": {
+                    "type": "string",
+                    "enum": [
+                      "all",
+                      "admin_only",
+                      "user_only",
+                      "department",
+                      "department_position",
+                      "project",
+                      "user",
+                      "contract_type"
+                    ]
+                  },
+                  "target_id": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "maxLength": 255
+                  },
+                  "target_name": {
+                    "type": [
+                      "string",
+                      "null"
+                    ],
+                    "maxLength": 255
+                  }
+                },
+                "required": [
+                  "target_type"
+                ]
+              }
+            }
+          },
+          "required": [
+            "targets"
+          ],
+          "title": "SetPolicyTargetsRequest"
+        }
+      },
+      "resultPath": "targets",
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "store-version",
+      "domain": "policy",
+      "operationId": "policy.storeVersion",
+      "method": "POST",
+      "path": "/v2/policies/{policyId}/versions",
+      "summary": "",
+      "pathParams": [
+        {
+          "name": "policyId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "attachment_id": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "file_name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "file_size": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "minimum": 0
+            },
+            "effective_from": {
+              "type": "string",
+              "format": "date"
+            },
+            "effective_to": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date"
+            },
+            "note": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 1000
+            }
+          },
+          "required": [
+            "attachment_id",
+            "file_name",
+            "effective_from"
+          ],
+          "title": "StorePolicyVersionRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "targets",
+      "domain": "policy",
+      "operationId": "policy.targets",
+      "method": "GET",
+      "path": "/v2/policies/{policyId}/targets",
+      "summary": "",
+      "pathParams": [
+        {
+          "name": "policyId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "targets",
+      "risk": "read",
+      "aliases": []
+    },
+    {
+      "name": "update",
+      "domain": "policy",
+      "operationId": "policy.update",
+      "method": "PUT",
+      "path": "/v2/policies/{policyId}",
+      "summary": "",
+      "pathParams": [
+        {
+          "name": "policyId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "category": {
+              "type": "string",
+              "enum": [
+                "work_rules",
+                "leave_and_duty",
+                "allowance_and_expense",
+                "supplementary_provisions",
+                "information_security",
+                "article36_agreement",
+                "labor_agreement"
+              ]
+            },
+            "title": {
+              "type": "string",
+              "maxLength": 255
+            }
+          },
+          "title": "UpdatePolicyRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "update-version",
+      "domain": "policy",
+      "operationId": "policy.updateVersion",
+      "method": "PUT",
+      "path": "/v2/policies/{policyId}/versions/{versionId}",
+      "summary": "",
+      "pathParams": [
+        {
+          "name": "policyId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        },
+        {
+          "name": "versionId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [],
+      "body": {
+        "schema": {
+          "type": "object",
+          "properties": {
+            "attachment_id": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "file_name": {
+              "type": "string",
+              "maxLength": 255
+            },
+            "file_size": {
+              "type": [
+                "integer",
+                "null"
+              ],
+              "minimum": 0
+            },
+            "effective_from": {
+              "type": "string",
+              "format": "date"
+            },
+            "effective_to": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "format": "date"
+            },
+            "note": {
+              "type": [
+                "string",
+                "null"
+              ],
+              "maxLength": 1000
+            }
+          },
+          "title": "UpdatePolicyVersionRequest"
+        }
+      },
+      "resultPath": null,
+      "risk": "write",
+      "aliases": []
+    },
+    {
+      "name": "versions",
+      "domain": "policy",
+      "operationId": "policy.versions",
+      "method": "GET",
+      "path": "/v2/policies/{policyId}/versions",
+      "summary": "版一覧（総務は過去版を含む全版）。",
+      "pathParams": [
+        {
+          "name": "policyId",
+          "type": "string",
+          "required": true,
+          "source": "spec"
+        }
+      ],
+      "queryParams": [
+        {
+          "name": "limit",
+          "type": "integer",
+          "required": false,
+          "description": "1ページあたりの件数",
+          "source": "curation"
+        },
+        {
+          "name": "cursor",
+          "type": "string",
+          "required": false,
+          "description": "次ページの取得に使うカーソル",
+          "source": "curation"
+        }
+      ],
+      "body": null,
+      "resultPath": "versions",
+      "risk": "read",
+      "aliases": []
+    }
+  ]
+}