@youzan-cloud/zan-saas-cli 0.0.0-stage → 0.1.0-beta.4

package/src/commands/native/access/staff-perms/get/schema.json

@@ -0,0 +1,703 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "kdtId",
+      "mobile"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "kdtId": {
+        "$ref": "#/definitions/shopId"
+      },
+      "mobile": {
+        "type": "string",
+        "pattern": "^1[0-9]{10}$",
+        "description": "员工登录账号手机号；仅去首尾普通空格，不使用联系人或客户号码。"
+      },
+      "permKey": {
+        "$ref": "#/definitions/permKey"
+      }
+    }
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "permissions"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "permissions": {
+            "type": "array",
+            "description": "本次筛选范围的员工权限点，非仅菜单权限；无分页，保持顺序及重复。省略 permKey 时读取完整权限点；指定时只查询该 key，成功空数组不表示员工没有其他权限。",
+            "items": {
+              "type": "object",
+              "required": [
+                "permId",
+                "permKey",
+                "name"
+              ],
+              "additionalProperties": false,
+              "properties": {
+                "permId": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 9007199254740991,
+                  "description": "权限点标识，不是角色或员工标识。"
+                },
+                "permKey": {
+                  "type": "string",
+                  "description": "权限点业务 key，服务端空串保留，不由名称推导。"
+                },
+                "name": {
+                  "type": "string",
+                  "description": "权限点名称，空串保留。"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "required": [
+      "scope",
+      "requests"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "scope": {
+        "type": "object",
+        "required": [
+          "kdtId"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "kdtId": {
+            "$ref": "#/definitions/shopId"
+          }
+        }
+      },
+      "requests": {
+        "type": "array",
+        "minItems": 3,
+        "maxItems": 3,
+        "additionalItems": false,
+        "items": [
+          {
+            "type": "object",
+            "required": [
+              "stage",
+              "method",
+              "path",
+              "body"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "stage": {
+                "const": "shop-binding"
+              },
+              "method": {
+                "const": "POST"
+              },
+              "path": {
+                "const": "youzan.shop.basic.get/3.0.0"
+              },
+              "body": {
+                "type": "object",
+                "additionalProperties": false,
+                "properties": {}
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "stage",
+              "method",
+              "path",
+              "body"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "stage": {
+                "const": "staff"
+              },
+              "method": {
+                "const": "POST"
+              },
+              "path": {
+                "const": "youzan.shop.single.staff.get/1.0.0"
+              },
+              "body": {
+                "type": "object",
+                "required": [
+                  "account"
+                ],
+                "additionalProperties": false,
+                "properties": {
+                  "account": {
+                    "const": "***"
+                  }
+                }
+              }
+            }
+          },
+          {
+            "type": "object",
+            "required": [
+              "stage",
+              "method",
+              "path",
+              "body"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "stage": {
+                "const": "permissions"
+              },
+              "method": {
+                "const": "POST"
+              },
+              "path": {
+                "const": "youzan.shop.rig.open.query.perms/1.0.0"
+              },
+              "body": {
+                "type": "object",
+                "required": [
+                  "kdt_id",
+                  "yz_open_id",
+                  "platform"
+                ],
+                "additionalProperties": false,
+                "properties": {
+                  "kdt_id": {
+                    "$ref": "#/definitions/shopId"
+                  },
+                  "yz_open_id": {
+                    "const": "***"
+                  },
+                  "platform": {
+                    "const": 0,
+                    "description": "通用终端。"
+                  },
+                  "perm_keys": {
+                    "type": "string",
+                    "description": "选定单个权限 key 的 JSON 数组文本；不选择时省略。"
+                  }
+                }
+              }
+            }
+          }
+        ]
+      }
+    }
+  },
+  "error": {
+    "type": "object",
+    "required": [
+      "success",
+      "code",
+      "message",
+      "details"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "success": {
+        "const": false
+      },
+      "code": {
+        "const": -10001
+      },
+      "message": {
+        "type": "string",
+        "minLength": 1
+      },
+      "details": {
+        "type": "object",
+        "required": [
+          "category",
+          "stage",
+          "command",
+          "targetScope",
+          "requestState",
+          "nextStep",
+          "errorVersion",
+          "recovery",
+          "execution"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "category": {
+            "enum": [
+              "parameter",
+              "validation",
+              "configuration",
+              "authentication",
+              "permission",
+              "scope_unresolved",
+              "transport",
+              "http",
+              "protocol",
+              "business_rejected",
+              "not_found",
+              "limit"
+            ]
+          },
+          "stage": {
+            "enum": [
+              "input",
+              "context",
+              "scope",
+              "configuration",
+              "shop-binding",
+              "staff",
+              "staff-model",
+              "permissions",
+              "permissions-model",
+              "transport",
+              "http",
+              "response"
+            ]
+          },
+          "command": {
+            "const": "access.staff-perms.get"
+          },
+          "targetScope": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "kdtId": {
+                "$ref": "#/definitions/shopId"
+              }
+            }
+          },
+          "requestState": {
+            "enum": [
+              "not_sent",
+              "sent",
+              "unknown"
+            ]
+          },
+          "nextStep": {
+            "type": "string",
+            "minLength": 1
+          },
+          "api": {
+            "type": "string"
+          },
+          "httpStatus": {
+            "type": "integer"
+          },
+          "businessCode": {
+            "$ref": "#/definitions/diagnosticCode"
+          },
+          "gatewayCode": {
+            "$ref": "#/definitions/diagnosticCode"
+          },
+          "trace_id": {
+            "type": "string",
+            "pattern": "^[A-Za-z0-9_-]{1,128}$"
+          },
+          "request_id": {
+            "type": "string",
+            "pattern": "^[A-Za-z0-9_-]{1,128}$"
+          },
+          "errorVersion": {
+            "const": 2,
+            "description": "本命令采用错误诊断协议第二版。"
+          },
+          "issues": {
+            "type": "array",
+            "minItems": 1,
+            "maxItems": 16,
+            "items": {
+              "$ref": "#/definitions/diagnosticIssue"
+            },
+            "description": "最多十六个已定位问题，不包含收到的原值。"
+          },
+          "issuesTruncated": {
+            "const": true,
+            "description": "问题超过返回上限，当前列表没有穷尽全部问题。"
+          },
+          "recovery": {
+            "$ref": "#/definitions/diagnosticRecovery",
+            "description": "受限的恢复说明，不会自动执行。"
+          },
+          "execution": {
+            "$ref": "#/definitions/diagnosticExecution",
+            "description": "整次调用的请求观察，独立于失败阶段的 requestState。"
+          }
+        }
+      }
+    }
+  },
+  "definitions": {
+    "shopId": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 9007199254740991,
+      "description": "当前上下文同店正安全整数，凭证、员工资料与权限查询必须同店。"
+    },
+    "permKey": {
+      "type": "string",
+      "minLength": 1,
+      "pattern": "^[^\\s\\x00-\\x1f\\x7f-\\x9f]+$",
+      "description": "一个不含空白或控制字符的权限 key，按单值原文传递，不拆分逗号。"
+    },
+    "diagnosticCode": {
+      "anyOf": [
+        {
+          "type": "integer",
+          "minimum": -9007199254740991,
+          "maximum": 9007199254740991
+        },
+        {
+          "type": "string",
+          "pattern": "^-?\\d{1,12}$"
+        }
+      ]
+    },
+    "diagnosticExpected": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [],
+      "properties": {
+        "type": {
+          "anyOf": [
+            {
+              "type": "string",
+              "description": "预期的 JSON 类型。"
+            },
+            {
+              "type": "array",
+              "items": {
+                "type": "string",
+                "description": "预期的 JSON 类型。"
+              }
+            }
+          ],
+          "description": "同版模型允许的类型。"
+        },
+        "enum": {
+          "type": "array",
+          "items": {
+            "anyOf": [
+              {
+                "type": "string"
+              },
+              {
+                "type": "number"
+              },
+              {
+                "type": "boolean"
+              },
+              {
+                "type": "null"
+              }
+            ],
+            "description": "契约声明的静态标量约束。"
+          },
+          "description": "同版模型允许的静态值。"
+        },
+        "const": {
+          "anyOf": [
+            {
+              "type": "string"
+            },
+            {
+              "type": "number"
+            },
+            {
+              "type": "boolean"
+            },
+            {
+              "type": "null"
+            }
+          ],
+          "description": "契约声明的静态标量约束。"
+        },
+        "minimum": {
+          "type": "number",
+          "description": "包含的最小值。"
+        },
+        "maximum": {
+          "type": "number",
+          "description": "包含的最大值。"
+        },
+        "exclusiveMinimum": {
+          "type": "number",
+          "description": "不包含的最小值。"
+        },
+        "exclusiveMaximum": {
+          "type": "number",
+          "description": "不包含的最大值。"
+        },
+        "minLength": {
+          "type": "integer",
+          "description": "最少字符数。"
+        },
+        "maxLength": {
+          "type": "integer",
+          "description": "最多字符数。"
+        },
+        "minItems": {
+          "type": "integer",
+          "description": "最少元素数。"
+        },
+        "maxItems": {
+          "type": "integer",
+          "description": "最多元素数。"
+        },
+        "format": {
+          "type": "string",
+          "description": "同版模型声明的格式。"
+        },
+        "pattern": {
+          "type": "string",
+          "description": "同版模型声明的字符约束。"
+        },
+        "additionalProperties": {
+          "const": false,
+          "description": "对象拒绝契约以外的属性。"
+        },
+        "contains": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "const"
+          ],
+          "properties": {
+            "const": {
+              "anyOf": [
+                {
+                  "type": "string"
+                },
+                {
+                  "type": "number"
+                },
+                {
+                  "type": "boolean"
+                },
+                {
+                  "type": "null"
+                }
+              ],
+              "description": "契约声明的静态标量约束。"
+            }
+          }
+        },
+        "items": {
+          "type": "object",
+          "additionalProperties": false,
+          "required": [
+            "enum"
+          ],
+          "properties": {
+            "enum": {
+              "type": "array",
+              "items": {
+                "anyOf": [
+                  {
+                    "type": "string"
+                  },
+                  {
+                    "type": "number"
+                  },
+                  {
+                    "type": "boolean"
+                  },
+                  {
+                    "type": "null"
+                  }
+                ],
+                "description": "契约声明的静态标量约束。"
+              },
+              "description": "元素允许的静态值。"
+            }
+          }
+        }
+      }
+    },
+    "diagnosticIssue": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "source",
+        "reason"
+      ],
+      "properties": {
+        "source": {
+          "enum": [
+            "argv",
+            "input",
+            "context",
+            "output",
+            "preview"
+          ],
+          "description": "问题所属的参数、输入、上下文、结果或预览模型。"
+        },
+        "path": {
+          "type": "string",
+          "description": "对应模型中的 JSON Pointer；不含原始输入或动态字典键。"
+        },
+        "option": {
+          "type": "string",
+          "description": "可定位时给出的已注册 CLI 选项。"
+        },
+        "reason": {
+          "enum": [
+            "required",
+            "invalid_type",
+            "invalid_choice",
+            "out_of_range",
+            "invalid_format",
+            "conditional_required",
+            "constraint",
+            "unexpected_property",
+            "unknown_option",
+            "unknown_command",
+            "excess_arguments",
+            "missing_value"
+          ],
+          "description": "字段违反的约束类型，原始值不回显。"
+        },
+        "expected": {
+          "$ref": "#/definitions/diagnosticExpected",
+          "description": "同版契约的静态预期。"
+        },
+        "relatedPaths": {
+          "type": "array",
+          "items": {
+            "type": "string",
+            "description": "关联字段的 JSON Pointer。"
+          },
+          "description": "触发条件约束的关联字段。"
+        }
+      }
+    },
+    "diagnosticRecovery": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "action",
+        "automaticBusinessRetry"
+      ],
+      "properties": {
+        "action": {
+          "enum": [
+            "correct_input",
+            "complete_authentication",
+            "request_access_review",
+            "stop_and_inspect"
+          ],
+          "description": "依次表示修正本地输入、补认证、核对权限或停止核查；仅是说明，不执行操作或授予权限。"
+        },
+        "automaticBusinessRetry": {
+          "const": false,
+          "description": "不据此自动重放业务请求。"
+        }
+      }
+    },
+    "diagnosticExecution": {
+      "type": "object",
+      "additionalProperties": false,
+      "required": [
+        "requestState",
+        "coverage",
+        "observedAttempts"
+      ],
+      "properties": {
+        "requestState": {
+          "enum": [
+            "not_sent",
+            "sent",
+            "unknown"
+          ],
+          "description": "整次调用尚未发送、已有发送记录或无法排除未知请求；不代表业务完成。"
+        },
+        "coverage": {
+          "enum": [
+            "complete",
+            "partial"
+          ],
+          "description": "请求观察覆盖全部已接入路径，或存在未观测路径；部分覆盖不能声明零请求。"
+        },
+        "observedAttempts": {
+          "type": "integer",
+          "minimum": 0,
+          "maximum": 9007199254740991,
+          "description": "本地已进入发送边界的观测次数下界，不是服务端执行次数。"
+        }
+      }
+    }
+  },
+  "modules": {
+    "permissions": {
+      "base": true,
+      "required": true,
+      "upstreamPath": "data",
+      "description": "当前员工权限点的有限视图，不推导授角建议或购买状态。"
+    }
+  },
+  "api": {
+    "method": "POST",
+    "path": "youzan.shop.rig.open.query.perms/1.0.0"
+  },
+  "success": {
+    "description": "凭证及员工均属于当前单店，权限查询明确成功且每个权限点字段有效，返回 data.permissions。"
+  },
+  "errors": {
+    "description": "员工不存在、业务拒绝、调用者无权限和协议异常均失败；缺字段不补空数组。失败 stdout 为空，stderr 单一脱敏信封，不输出部分员工或权限。",
+    "diagnosticsVersion": 2,
+    "responseReasons": {
+      "staff_object_invalid": {
+        "category": "protocol",
+        "stage": "staff-model",
+        "message": "员工接口返回的 data 不是员工对象，已停止查询权限。",
+        "nextStep": "保留本次店铺和失败记录，向服务端核对员工接口的响应字段及目标归属；不重放、换店或换身份。"
+      },
+      "staff_shop_id_invalid": {
+        "category": "protocol",
+        "stage": "staff-model",
+        "message": "员工接口返回的 data.kdt_id 缺失或不是正安全整数，已停止查询权限。",
+        "nextStep": "保留本次店铺和失败记录，向服务端核对员工接口的响应字段及目标归属；不重放、换店或换身份。"
+      },
+      "staff_shop_mismatch": {
+        "category": "scope_unresolved",
+        "stage": "staff-model",
+        "message": "员工接口返回的 data.kdt_id 与目标店铺不一致，已停止查询权限。",
+        "nextStep": "保留本次店铺和失败记录，向服务端核对员工接口的响应字段及目标归属；不重放、换店或换身份。"
+      },
+      "staff_identity_invalid": {
+        "category": "protocol",
+        "stage": "staff-model",
+        "message": "员工接口返回的 data.yz_open_id 缺失或不是非空字符串，已停止查询权限。",
+        "nextStep": "保留本次店铺和失败记录，向服务端核对员工接口的响应字段及目标归属；不重放、换店或换身份。"
+      },
+      "staff_account_mismatch": {
+        "category": "scope_unresolved",
+        "stage": "staff-model",
+        "message": "员工接口返回的 data.account 与输入登录账号不一致，已停止查询权限。",
+        "nextStep": "保留本次店铺和失败记录，向服务端核对员工接口的响应字段及目标归属；不重放、换店或换身份。"
+      }
+    }
+  },
+  "notes": [
+    "仅当前授权微商城单店；不支持总部、跨店或账号扫描。单店组织角色不能证明产品适用性，服务端决定实际授权范围。",
+    "先核验凭证店铺，再定位员工并查询权限，最多三请求、同一目标和凭证快照；10 秒超时，不重试、重定向或切换身份。",
+    "dry-run 不联网，账号和派生员工标识固定掩码；缺少上下文时只能指定合法店铺做预览。",
+    "省略 perm-key 查询全部权限点，提供时仅查询一个 key；不缩减为菜单权限，不从员工角色或角色目录推导。",
+    "每次响应最多 8 MiB，超限整体失败，不截断权限集合；最多三次请求。"
+  ]
+}