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

package/src/commands/native/benefit/card-definition/list/schema.json

@@ -0,0 +1,690 @@
+{
+  "schemaVersion": 1,
+  "input": {
+    "type": "object",
+    "required": [
+      "kdtId",
+      "pageNo"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "kdtId": {
+        "$ref": "#/definitions/positiveInteger"
+      },
+      "pageNo": {
+        "type": "integer",
+        "minimum": 1,
+        "maximum": 100,
+        "description": "页码，十进制整数 1..100；仅查询指定单页"
+      }
+    },
+    "description": "CLI 解析参数并完成必要上下文补全后的业务输入；不是直接传入 CLI 的 JSON。原始选项、必填条件和默认值见 options。"
+  },
+  "output": {
+    "type": "object",
+    "required": [
+      "data"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "data": {
+        "type": "object",
+        "required": [
+          "cards",
+          "pagination"
+        ],
+        "additionalProperties": false,
+        "properties": {
+          "cards": {
+            "type": "array",
+            "items": {
+              "type": "object",
+              "additionalProperties": false,
+              "required": [
+                "cardAlias",
+                "cardId",
+                "name",
+                "isAvailable",
+                "grantType"
+              ],
+              "properties": {
+                "cardAlias": {
+                  "type": "string",
+                  "minLength": 1,
+                  "description": "商家权益卡定义唯一别名；同页不可重复。"
+                },
+                "cardId": {
+                  "$ref": "#/definitions/positiveInteger",
+                  "description": "定义数字 ID，不是客户卡号。"
+                },
+                "name": {
+                  "type": "string"
+                },
+                "isAvailable": {
+                  "type": "boolean",
+                  "description": "true 使用中，false 已禁用；不转换为详情 status。"
+                },
+                "grantType": {
+                  "type": "string",
+                  "minLength": 1,
+                  "description": "3 无门槛卡、2 付费卡、1 规则卡；未知非空编码原样保留，不等同详情 cardType。"
+                },
+                "cardUrl": {
+                  "type": "string",
+                  "description": "发卡链接，仅返回，不访问。"
+                },
+                "createdAt": {
+                  "anyOf": [
+                    {
+                      "type": "string",
+                      "format": "beijing-date-time-ms"
+                    },
+                    {
+                      "const": ""
+                    }
+                  ],
+                  "$comment": "upstream-time:text:empty",
+                  "description": "创建时间；北京时间 YYYY-MM-DD HH:mm:ss.SSS。业务哨兵原值保留：['']。"
+                }
+              }
+            }
+          },
+          "pagination": {
+            "type": "object",
+            "required": [
+              "pageNo",
+              "pageSize",
+              "returned",
+              "hasMore",
+              "nextPageNo",
+              "windowLimitReached"
+            ],
+            "additionalProperties": false,
+            "properties": {
+              "pageNo": {
+                "type": "integer",
+                "minimum": 1,
+                "description": "本次结果对应的页码。"
+              },
+              "pageSize": {
+                "type": "integer",
+                "minimum": 1,
+                "description": "服务端本次响应采用的每页容量。"
+              },
+              "returned": {
+                "type": "integer",
+                "minimum": 0,
+                "description": "本次响应中 data.cards 的数组长度，不是匹配总数、累计条数或嵌套记录数。"
+              },
+              "hasMore": {
+                "type": ["boolean", "null"],
+                "description": "true 表示还有后续页，false 表示已确认没有后续页；无法确定时为 null，不以空页或短页推算。"
+              },
+              "total": {
+                "type": "integer",
+                "minimum": 0,
+                "maximum": 9007199254740991,
+                "description": "匹配本次查询条件的总记录数，不是当前页返回条数；上游未提供可确认总数时省略。"
+              },
+              "nextPageNo": {
+                "type": [
+                  "integer",
+                  "null"
+                ],
+                "minimum": 1,
+                "maximum": 100,
+                "description": "已确认且未超过页码上限的下一页；无法确认或到达上限时为 null。"
+              },
+              "windowLimitReached": {
+                "type": "boolean",
+                "description": "仍有后续但已到本入口页码上限时为 true；不能宣称已取完或继续请求下一页。"
+              }
+            },
+            "description": "本次查询范围的分页信号；total 不保证跨页快照。"
+          }
+        }
+      }
+    }
+  },
+  "preview": {
+    "type": "object",
+    "required": [
+      "scope",
+      "prerequisites",
+      "requests"
+    ],
+    "additionalProperties": false,
+    "properties": {
+      "scope": {
+        "$ref": "#/definitions/scope"
+      },
+      "prerequisites": {
+        "type": "array",
+        "minItems": 1,
+        "maxItems": 1,
+        "items": {
+          "type": "object",
+          "required": [
+            "method",
+            "path",
+            "body"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "method": {
+              "const": "POST"
+            },
+            "path": {
+              "const": "youzan.shop.basic.get/3.0.0"
+            },
+            "body": {
+              "type": "object",
+              "additionalProperties": false
+            }
+          }
+        }
+      },
+      "requests": {
+        "type": "array",
+        "minItems": 1,
+        "maxItems": 1,
+        "items": {
+          "type": "object",
+          "required": [
+            "method",
+            "path",
+            "body"
+          ],
+          "additionalProperties": false,
+          "properties": {
+            "method": {
+              "const": "POST"
+            },
+            "path": {
+              "const": "youzan.scrm.card.list/3.0.0"
+            },
+            "body": {
+              "type": "object",
+              "required": [
+                "page"
+              ],
+              "additionalProperties": false,
+              "properties": {
+                "page": {
+                  "type": "integer",
+                  "minimum": 1,
+                  "maximum": 100
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "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",
+        "additionalProperties": false,
+        "required": [
+          "category",
+          "stage",
+          "command",
+          "targetScope",
+          "requestState",
+          "nextStep",
+          "errorVersion",
+          "recovery",
+          "execution"
+        ],
+        "properties": {
+          "category": {
+            "enum": [
+              "parameter",
+              "validation",
+              "configuration",
+              "permission",
+              "authentication",
+              "scope_unresolved",
+              "transport",
+              "http",
+              "protocol",
+              "business_rejected"
+            ]
+          },
+          "stage": {
+            "type": "string",
+            "minLength": 1
+          },
+          "command": {
+            "const": "benefit.card-definition.list"
+          },
+          "targetScope": {
+            "type": "object",
+            "additionalProperties": false,
+            "properties": {
+              "kdtId": {
+                "$ref": "#/definitions/positiveInteger"
+              }
+            }
+          },
+          "requestState": {
+            "enum": [
+              "not_sent",
+              "sent",
+              "unknown"
+            ]
+          },
+          "nextStep": {
+            "type": "string",
+            "minLength": 1
+          },
+          "api": {
+            "type": "string"
+          },
+          "httpStatus": {
+            "type": "integer",
+            "minimum": 100,
+            "maximum": 599
+          },
+          "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": {
+    "positiveInteger": {
+      "type": "integer",
+      "minimum": 1,
+      "maximum": 9007199254740991
+    },
+    "scope": {
+      "type": "object",
+      "required": [
+        "kdtId"
+      ],
+      "additionalProperties": false,
+      "properties": {
+        "kdtId": {
+          "$ref": "#/definitions/positiveInteger"
+        }
+      }
+    },
+    "diagnosticCode": {
+      "oneOf": [
+        {
+          "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": {
+    "cards": {
+      "base": true,
+      "upstreamPath": "data.items",
+      "required": true,
+      "description": "指定单页的商家权益卡定义；保留顺序、禁用卡和未知类型。"
+    },
+    "pagination": {
+      "base": true,
+      "upstreamPath": "data",
+      "required": true,
+      "description": "单页分页；采用实际容量，未取得总数时省略 total，不以空页推断结束。"
+    }
+  },
+  "api": {
+    "method": "POST",
+    "path": "youzan.scrm.card.list/3.0.0"
+  },
+  "success": {
+    "description": "本页定义及分页模型完整、alias 唯一且分页一致后整体成功。"
+  },
+  "errors": {
+    "description": "失败 stdout 为空，stderr 为一份脱敏错误 JSON，退出码非零；不返回部分成功，不自动重试、切换身份或目标。按 error 模型及安全下一步处理。",
+    "diagnosticsVersion": 2
+  },
+  "notes": [
+    "每次只查询一页权益卡定义，默认第 1 页，最大第 100 页；页容量由服务端决定，不支持 --page-size。保留返回顺序和禁用卡。",
+    "pageSize 为本次实际页容量，returned 为本次卡定义条数；不按空页或短页判断结束。第 100 页仍有更多时不能继续第 101 页，也不能宣称全量。",
+    "可选字段缺失保持省略，已选字段 null 或错型失败；保留空字符串和 false。",
+    "支持微商城单店、零售单店、连锁 D 总部、网店及合伙人，不承诺跨页快照。",
+    "本地 --dry-run 不读取凭证、不联网；预览只证明构造计划，不证明对象存在或权限有效。真实执行仍需有效上下文及目标范围授权，at 声明不替代服务端授权。",
+    "total 是接口报告的本次筛选总数；继续读取 nextPageNo，windowLimitReached=true 时停止该入口，不把当前页当成全量。"
+  ]
+}