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

package/src/commands/native/org/unit/list/schema.json

@@ -0,0 +1,828 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "kdtId",
+      "pageNo",
+      "pageSize",
+      "orgRoles",
+      "include"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "kdtId": {
+        "$ref": "#/definitions/shopId"
+      },
+      "pageNo": {
+        "$ref": "#/definitions/pageNo"
+      },
+      "pageSize": {
+        "$ref": "#/definitions/pageSize"
+      },
+      "orgRoles": {
+        "$ref": "#/definitions/orgRoles"
+      },
+      "include": {
+        "$ref": "#/definitions/include"
+      }
+    }
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "units",
+          "pagination"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "units": {
+            "type": "array",
+            "maxItems": 50,
+            "description": "原顺序的单页有限摘要，长度不超过请求 pageSize；kdtId 不重复。不自动遍历、过滤 CRM 后重算 total 或补查详情。",
+            "items": {
+              "type": "object",
+              "required": [
+                "kdtId",
+                "name",
+                "orgRole"
+              ],
+              "additionalProperties": false,
+              "properties": {
+                "kdtId": {
+                  "$ref": "#/definitions/shopId"
+                },
+                "name": {
+                  "type": "string",
+                  "minLength": 1,
+                  "pattern": "\\S"
+                },
+                "orgRole": {
+                  "type": "integer",
+                  "minimum": 0,
+                  "maximum": 9007199254740991,
+                  "not": {
+                    "const": 9
+                  },
+                  "description": "响应组织角色：2001 门店、2002 网店、3 独立仓、4 合伙人、6 分销供货店铺、7 前置仓；9 三方 CRM 门店已排除，若返回整次 scope_unresolved。不等同请求筛选组。未筛选时其他未知合法代码原值保留；有筛选时必须符合已知映射。"
+                },
+                "joinType": {
+                  "$ref": "#/definitions/nonnegativeInteger",
+                  "description": "经营模式，1 直营、2 加盟；未知合法代码原值保留，不推断组织分类。"
+                },
+                "parentKdtId": {
+                  "$ref": "#/definitions/shopId"
+                },
+                "externalCode": {
+                  "type": "string",
+                  "description": "节点的三方编码，不是店铺主键，允许空串。"
+                },
+                "address": {
+                  "type": "object",
+                  "required": [
+                    "address"
+                  ],
+                  "additionalProperties": false,
+                  "properties": {
+                    "address": {
+                      "type": "string"
+                    },
+                    "county": {
+                      "type": "string"
+                    },
+                    "countyId": {
+                      "$ref": "#/definitions/nonnegativeInteger"
+                    }
+                  },
+                  "description": "仅 include address 时必需，列表摘要不承诺省市、经纬度，保留空串和 countyId=0。"
+                },
+                "departments": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "required": [
+                      "departmentId"
+                    ],
+                    "additionalProperties": false,
+                    "properties": {
+                      "departmentId": {
+                        "$ref": "#/definitions/shopId"
+                      },
+                      "name": {
+                        "type": "string"
+                      },
+                      "externalDepartmentId": {
+                        "type": "string"
+                      }
+                    }
+                  },
+                  "description": "仅 include departments 时必需。明确空数组成功，缺失或 null 失败，不代表完整部门树。"
+                },
+                "status": {
+                  "type": "object",
+                  "minProperties": 1,
+                  "additionalProperties": false,
+                  "properties": {
+                    "onlineBusinessStatus": {
+                      "type": "string",
+                      "minLength": 1,
+                      "description": "网店渠道营业状态：字符串 2 为运营中、字符串 3 为停用，未知非空字符串原值保留。"
+                    },
+                    "offlineBusinessStatus": {
+                      "type": "string",
+                      "minLength": 1,
+                      "description": "门店渠道营业状态：字符串 2 为运营中、字符串 3 为停用，未知非空字符串原值保留。"
+                    },
+                    "storeStatus": {
+                      "type": "string",
+                      "description": "门店状态：try 试用期、valid 有效期、protect 保护期、pause 歇业、close 打烊、undefined 未定义；空串和未知文本保留，字面 null 仍为字符串，不推导不存在。JSON null/缺省省略。"
+                    }
+                  },
+                  "description": "仅 include status 时必需且至少一个有效字段；三个状态独立，不合成为 enabled 或详情 operationStatus。"
+                },
+                "lifecycle": {
+                  "type": "object",
+                  "required": [
+                    "endsAt"
+                  ],
+                  "additionalProperties": false,
+                  "properties": {
+                    "endsAt": {
+                      "type": "string",
+                      "format": "beijing-date-time-ms",
+                      "$comment": "upstream-time:text",
+                      "description": "生命周期结束时间，固定 UTC+08:00 北京时间 YYYY-MM-DD HH:mm:ss.SSS，固定三位毫秒。缺失、null、空串或非法时间均失败，不能解释为永久有效；未选择 lifecycle 时省略且不校验。"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "pagination": {
+            "type": "object",
+            "required": [
+              "pageNo",
+              "pageSize",
+              "hasMore"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "pageNo": {
+                "$ref": "#/definitions/pageNo"
+              },
+              "pageSize": {
+                "$ref": "#/definitions/pageSize"
+              },
+              "total": {
+                "$ref": "#/definitions/nonnegativeInteger",
+                "type": "integer",
+                "minimum": 0,
+                "description": "匹配本次查询条件的总记录数，不是当前页返回条数；上游未提供可确认总数时省略。"
+              },
+              "hasMore": {
+                "type": ["boolean", "null"],
+                "description": "true 表示还有后续页，false 表示已确认没有后续页；无法确定时为 null，不以空页或短页推算。"
+              }
+            },
+            "description": "页码和容量必须与请求一致；总数与当前页范围须一致，不能用当前页长度代替总数；超末页空数组可成功。"
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "required": [
+      "scope",
+      "requests",
+      "selection"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "scope": {
+        "type": "object",
+        "required": [
+          "kdtId"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "kdtId": {
+            "$ref": "#/definitions/shopId"
+          }
+        }
+      },
+      "requests": {
+        "type": "array",
+        "minItems": 2,
+        "maxItems": 2,
+        "items": {
+          "oneOf": [
+            {
+              "type": "object",
+              "required": [
+                "stage",
+                "method",
+                "path",
+                "body"
+              ],
+              "additionalProperties": false,
+              "properties": {
+                "stage": {
+                  "const": "unit-basic"
+                },
+                "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": "units"
+                },
+                "method": {
+                  "const": "POST"
+                },
+                "path": {
+                  "const": "youzan.shop.chain.descendent.organization.list/1.0.1"
+                },
+                "body": {
+                  "type": "object",
+                  "required": [
+                    "page_num",
+                    "page_size",
+                    "with_dept_info",
+                    "with_shop_status_and_lifecycle_end_time",
+                    "with_crm_shop"
+                  ],
+                  "additionalProperties": false,
+                  "properties": {
+                    "page_num": {
+                      "$ref": "#/definitions/pageNo"
+                    },
+                    "page_size": {
+                      "$ref": "#/definitions/pageSize"
+                    },
+                    "shop_roles": {
+                      "type": "array",
+                      "minItems": 1,
+                      "uniqueItems": true,
+                      "items": {
+                        "enum": [
+                          2,
+                          3,
+                          4,
+                          6,
+                          7
+                        ]
+                      }
+                    },
+                    "with_dept_info": {
+                      "type": "boolean"
+                    },
+                    "with_shop_status_and_lifecycle_end_time": {
+                      "type": "boolean"
+                    },
+                    "with_crm_shop": {
+                      "const": false
+                    }
+                  }
+                }
+              }
+            }
+          ]
+        },
+        "description": "先核验同凭证所属总部，再查指定页；预览不读凭证或联网。"
+      },
+      "selection": {
+        "type": "object",
+        "required": [
+          "orgRoles",
+          "include"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "orgRoles": {
+            "$ref": "#/definitions/orgRoles"
+          },
+          "include": {
+            "$ref": "#/definitions/include"
+          }
+        }
+      }
+    }
+  },
+  "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"
+            ]
+          },
+          "stage": {
+            "enum": [
+              "input",
+              "context",
+              "scope",
+              "configuration",
+              "unit-basic",
+              "units",
+              "transport",
+              "http",
+              "response"
+            ]
+          },
+          "command": {
+            "const": "org.unit.list"
+          },
+          "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",
+            "minimum": 100,
+            "maximum": 599
+          },
+          "businessCode": {
+            "oneOf": [
+              {
+                "type": "integer"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          },
+          "gatewayCode": {
+            "oneOf": [
+              {
+                "type": "integer"
+              },
+              {
+                "type": "string"
+              }
+            ]
+          },
+          "trace_id": {
+            "type": "string"
+          },
+          "request_id": {
+            "type": "string"
+          },
+          "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
+    },
+    "nonnegativeInteger": {
+      "type": "integer",
+      "minimum": 0,
+      "maximum": 9007199254740991
+    },
+    "pageNo": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 2147483647,
+      "default": 1
+    },
+    "pageSize": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 50,
+      "default": 20
+    },
+    "orgRoles": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "enum": [
+          2,
+          3,
+          4,
+          6,
+          7
+        ]
+      },
+      "description": "封闭请求筛选组：2 门店/网店，对应响应 2001/2002；3 独立仓、4 合伙人、6 分销供货店铺、7 前置仓对应同值。CSV 去空白、去重，默认 [] 表示不筛选；显式空项拒绝。9 CRM 门店不支持，0/1/2001/2002 不是可填筛选组。"
+    },
+    "include": {
+      "type": "array",
+      "uniqueItems": true,
+      "items": {
+        "enum": [
+          "address",
+          "departments",
+          "status",
+          "lifecycle"
+        ]
+      },
+      "description": "CSV 去空白、去重，默认 []。未选择模块整体省略且不解析；选中模块的核心缺失整体失败，不降级。"
+    },
+    "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": "本地已进入发送边界的观测次数下界，不是服务端执行次数。"
+        }
+      }
+    }
+  },
+  "api": {
+    "method": "POST",
+    "path": "youzan.shop.chain.descendent.organization.list/1.0.1"
+  },
+  "success": {
+    "description": "已核实凭证属于当前总部，页码和容量与请求一致，每个组织及所有选定扩展均有效且符合筛选范围，不含 CRM 节点后返回 data.units 与 data.pagination。"
+  },
+  "errors": {
+    "description": "失败 stdout 为空，stderr 单一安全错误信封且退出 1；不返回部分列表、不重试、不换目标/身份、不降级模块。已排除 CRM 或无法核验的筛选角色为 scope_unresolved；分页、模型、时间非法为 protocol；中断 requestState=unknown。",
+    "diagnosticsVersion": 2
+  },
+  "notes": [
+    "at=hq 仅位置准入，真实目标固定当前总部；不是员工权限证明。",
+    "固定排除 CRM 节点，无 CRM 范围选项；所有 include 组合最多核验总部加查询一页两次请求。",
+    "可选明细缺省/null 省略，不代表无关联；0、空串和字面 null/undefined 不泛化为缺失。",
+    "生命周期时间固定 UTC+08:00，不使用宿主时区，不从缺失时间推断永久有效。",
+    "不承诺总部自身在结果中、营业门店清单、完整部门树、全量组织树或任意组织详情。"
+  ]
+}