openany-cli-dev 0.1.1 → 0.1.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +19 -19
- package/package.json +1 -1
- package/skills/openany/SKILL.md +17 -336
- package/skills/openany/calls.md +116 -0
- package/skills/openany/setup.md +235 -0
- package/skills/openany/topups.md +70 -0
- package/skills/openany-provider/SKILL.md +6 -2
- package/skills/openany-provider/SKILL.zh-CN.md +6 -2
- package/skills/openany-provider/references/apis.md +5 -5
- package/skills/openany-provider/references/apis.zh-CN.md +4 -4
- package/skills/openany-provider/references/application.md +1 -1
- package/skills/openany-provider/references/application.zh-CN.md +1 -1
- package/skills/openany-provider/references/connections.md +8 -8
- package/skills/openany-provider/references/connections.zh-CN.md +7 -7
- package/skills/openany-provider/references/imports.md +3 -3
- package/skills/openany-provider/references/imports.zh-CN.md +3 -3
- package/skills/openany-provider/references/models.md +8 -8
- package/skills/openany-provider/references/models.zh-CN.md +5 -5
- package/skills/openany-provider/references/publishing.md +3 -3
- package/skills/openany-provider/references/publishing.zh-CN.md +4 -4
- package/skills/openany-provider/references/reviews.md +2 -2
- package/skills/openany-provider/templates/bindings.json +1 -1
- package/skills/openany-provider/templates/models-v2.json +12 -12
- package/skills/openany-provider/templates/models.json +2 -2
- package/skills/openany-provider/templates/provider-agent-api-template.json +12 -12
- package/skills/openany-provider/templates/seller-agent-api-import-template.json +16 -16
- package/src/cli.js +12 -4
- package/src/provider-connections.js +2 -2
- package/src/provider-imports.js +5 -4
- package/src/provider-model-import-v2.js +10 -1
- package/src/provider.js +5 -3
- package/src/seller-fields.js +57 -0
|
@@ -9,7 +9,7 @@ openany-dev seller schema --type api --application APPLICATION_ID -j
|
|
|
9
9
|
openany-dev seller apis create --application APPLICATION_ID --file api.json --operation TASK-api-create-1 -j
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
按当前 schema 准备 `api.json`,包括当前供应商拥有的 `
|
|
12
|
+
按当前 schema 准备 `api.json`,包括当前供应商拥有的 `connectionId`、`name`、`description`、`method`、`pathTemplate`、`requestContentType` 和 `config`。保留实际计费、请求参数、映射和扣费条件,只补缺项。`price_micro_usd` 等金额使用微美元字符串。连接负责注入凭据。记录返回的 `id` 为 `API_ID`。
|
|
13
13
|
|
|
14
14
|
### 资源分类
|
|
15
15
|
|
|
@@ -17,7 +17,7 @@ openany-dev seller apis create --application APPLICATION_ID --file api.json --op
|
|
|
17
17
|
|
|
18
18
|
## 2. 使用已保存的配置
|
|
19
19
|
|
|
20
|
-
使用创建或导入回执确认草稿 ID。只建草稿时,报告 ID 后结束。验证需要 `id`、`revision`、`
|
|
20
|
+
使用创建或导入回执确认草稿 ID。只建草稿时,报告 ID 后结束。验证需要 `id`、`revision`、`connectionId` 和 `connectionRevision`,回执缺少当前步骤所需字段时才回读一次。
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
23
|
openany-dev seller apis get --application APPLICATION_ID --id API_ID -j
|
|
@@ -27,7 +27,7 @@ openany-dev seller apis get --application APPLICATION_ID --id API_ID -j
|
|
|
27
27
|
|
|
28
28
|
判断回执是否验证了当前配置时,核对 `state: "passed"`、`stale: false`,以及 API ID、修订、连接 ID 和连接修订是否一致。发布资格另按下文的历史验证规则判断。先核实运行中或结果不明的验证。确实需要新验证且测试请求和费用范围已获授权时,只运行一次。
|
|
29
29
|
|
|
30
|
-
用当前 `revision`、`
|
|
30
|
+
用当前 `revision`、`connectionRevision` 填写 `verification.json` 的 `expectedRevision`、`expectedConnectionRevision`,并提供获授权的 `request`。连接负责注入凭据。
|
|
31
31
|
|
|
32
32
|
```bash
|
|
33
33
|
openany-dev seller apis verify --application APPLICATION_ID --id API_ID --file verification.json --operation TASK-api-test-1 -j
|
|
@@ -38,7 +38,7 @@ openany-dev seller apis get --application APPLICATION_ID --id API_ID --verificat
|
|
|
38
38
|
|
|
39
39
|
## 4. 发布
|
|
40
40
|
|
|
41
|
-
供应商为 `live` 且已获发布授权后才发布。用当前保存的 API 和连接修订填写 `expectedRevision` 与 `
|
|
41
|
+
供应商为 `live` 且已获发布授权后才发布。用当前保存的 API 和连接修订填写 `expectedRevision` 与 `expectedConnectionRevision`。首次发布或发布异步 API 时,服务端要求该 API 有成功验证。可复用匹配的成功回执,或服务端返回的 `passedVerificationId`。引用历史回执时仍使用当前修订。已发布的同步 API 满足服务端检查时可以直接重新发布。引用回执时填入 `verificationId`。发布无需单独提交资源审核。
|
|
42
42
|
|
|
43
43
|
```bash
|
|
44
44
|
openany-dev seller apis publish --application APPLICATION_ID --id API_ID --file publication.json --operation TASK-api-publish-1 -j
|
|
@@ -28,7 +28,7 @@ Do not add questions about company registration, phone, address, prices, currenc
|
|
|
28
28
|
|
|
29
29
|
Always write `seller_types` explicitly: models only → `["model"]`; APIs only → `["api"]`; both → `["model", "api"]`. Do not omit the field (the backend defaults to APIs only for legacy applications), copy template defaults, or infer the sales types from `resource.type`, documentation format, or the fact that models are also called through HTTP APIs. Before submission, check that the array matches the user's original choice and show the types in the summary. Do not reconfirm an already explicit choice. If the receipt includes `providerTypes`, check that they match; report and investigate a mismatch rather than resubmitting.
|
|
30
30
|
|
|
31
|
-
After collecting form answers, validate required fields, formats, category choices, and required consents against the website application form. If validation fails, use the agent's native form to supplement or correct only the affected fields. Once all validation passes, construct `registration.json` internally using the website form mapping. For new applications, derive `resource.name` from the supplier name; set `resource.type` to `model` for Models only, otherwise `service`; set `resource.secondary_categories: []`, `connection.authentication: {"type":"none"}`, and `endpoints: []`. These are application request defaults, not extra user fields, and do not imply that future
|
|
31
|
+
After collecting form answers, validate required fields, formats, category choices, and required consents against the website application form. If validation fails, use the agent's native form to supplement or correct only the affected fields. Once all validation passes, construct `registration.json` internally using the website form mapping. For new applications, derive `resource.name` from the supplier name; set `resource.type` to `model` for Models only, otherwise `service`; set `resource.secondary_categories: []`, `connection.authentication: {"type":"none"}`, and `endpoints: []`. These are application request defaults, not extra user fields, and do not imply that future service access requires no authentication. Do not request or invent API credentials. If the current application contract rejects these fields/defaults, or category choices cannot be determined, report and resolve the inconsistency instead of expanding the form or guessing.
|
|
32
32
|
|
|
33
33
|
When the user has requested submission and both required consents have been provided, execute the creation command below. Report the returned application ID and review status, then stop. Submission does not mean approval or authorization to create, test, or publish resources.
|
|
34
34
|
|
|
@@ -30,7 +30,7 @@
|
|
|
30
30
|
|
|
31
31
|
必须显式写入 `seller_types`:仅模型 → `["model"]`;仅 API → `["api"]`;两者 → `["model", "api"]`。不得遗漏该字段(后端兼容旧申请时会默认仅 API),不得照抄模板默认值,也不得从 `resource.type`、文档格式或“模型也通过 HTTP API 调用”反推销售类型。提交前核对数组与用户原始选择一致,在摘要中展示类型;已有明确选择不重复确认。回执包含 `providerTypes` 时核对是否一致,若不一致先报告并核实,不重复提交。
|
|
32
32
|
|
|
33
|
-
收集表单答案后,先按网站申请表校验必填项、格式、分类选项及必要同意项;校验不通过时,仅通过 Agent 原生表单补充或修正对应字段。校验全部通过后,按照网站申请表的映射在内部构造 `registration.json`。对于新申请,由供应商名称生成 `resource.name`;仅选择 Models 时将 `resource.type` 设为 `model`,否则设为 `service`;设置 `resource.secondary_categories: []`、`connection.authentication: {"type":"none"}` 和 `endpoints: []
|
|
33
|
+
收集表单答案后,先按网站申请表校验必填项、格式、分类选项及必要同意项;校验不通过时,仅通过 Agent 原生表单补充或修正对应字段。校验全部通过后,按照网站申请表的映射在内部构造 `registration.json`。对于新申请,由供应商名称生成 `resource.name`;仅选择 Models 时将 `resource.type` 设为 `model`,否则设为 `service`;设置 `resource.secondary_categories: []`、`connection.authentication: {"type":"none"}` 和 `endpoints: []`。这些是申请请求数据的默认值,不是额外的用户字段,也不表示未来访问服务服务无须认证。不要索取或编造 API 凭据。如果当前申请接口约定拒绝这些字段/默认值,或无法确定分类选项,应报告并解决不一致问题,不要扩展表单或猜测。
|
|
34
34
|
|
|
35
35
|
在用户已要求提交,且两个必选同意项均已给出的情况下,执行下文的创建命令。报告返回的申请 ID 和审核状态,然后停止;提交不代表审核通过,也不代表已获授权创建、测试或发布资源。
|
|
36
36
|
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
# Select
|
|
1
|
+
# Select a connection
|
|
2
2
|
|
|
3
|
-
Use the confirmed CLI, email session, and supplier. In Dev, replace `openany-dev` in the commands below with `openany-dev`. When a resource needs
|
|
3
|
+
Use the confirmed CLI, email session, and supplier. In Dev, replace `openany-dev` in the commands below with `openany-dev`. When a resource needs a connection and the user has not specified one, ask only “Would you like to select an existing connection or add a new one?” Wait for the choice before continuing. If the user already selected a connection or requested a new one, go directly to that branch.
|
|
4
4
|
|
|
5
|
-
## Select an existing
|
|
5
|
+
## Select an existing connection
|
|
6
6
|
|
|
7
7
|
List the supplier's enabled connections as needed. Show the name, base URL, and authentication method and ask the user to choose one. Reuse any connection list you already have that contains no secrets. To see more results, pass the returned `nextCursor` to `--cursor`. If you confirm that there are no usable connections, ask whether to add one.
|
|
8
8
|
|
|
@@ -10,17 +10,17 @@ List the supplier's enabled connections as needed. Show the name, base URL, and
|
|
|
10
10
|
openany-dev seller connections list --application APPLICATION_ID -j
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
Confirm that the selection belongs to the current supplier and is enabled. Record its `id` and `revision`. Fetch the details by ID only if the existing receipt lacks required fields. If the connection's base URL or authentication method conflicts with known
|
|
13
|
+
Confirm that the selection belongs to the current supplier and is enabled. Record its `id` and `revision`. Fetch the details by ID only if the existing receipt lacks required fields. If the connection's base URL or authentication method conflicts with known service information, ask the user to confirm. The resource configuration supplies the endpoint path. Do not use that path to match connections.
|
|
14
14
|
|
|
15
|
-
## Add a new
|
|
15
|
+
## Add a new connection
|
|
16
16
|
|
|
17
|
-
If the user chooses to add a
|
|
17
|
+
If the user chooses to add a connection and has not supplied connection fields, run the command below immediately and wait for the dialog result. The dialog collects the connection name, base URL, authentication method, required parameter name, and API key in one step. Use the confirmed supplier ID and the operation identifier to open the dialog. Skip the connection schema lookup and do not ask for connection fields beforehand.
|
|
18
18
|
|
|
19
19
|
```bash
|
|
20
20
|
openany-dev seller connections create --application APPLICATION_ID --operation OPERATION --gui -j
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
On success, use the `id` and `revision` from the receipt. Read the connection back only if the receipt lacks required fields. For imports, use the connection ID as `
|
|
23
|
+
On success, use the `id` and `revision` from the receipt. Read the connection back only if the receipt lacks required fields. For imports, use the connection ID as `connectionId`. If the user cancels the dialog or it times out, preserve the current progress and wait for instructions.
|
|
24
24
|
|
|
25
25
|
If the native dialog is unavailable and no connection fields have been supplied, ask the user to run the command below in their local interactive terminal in the same environment. The terminal collects the connection fields in one step and hides key input. When finished, the user only needs to provide the connection ID.
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ If the native dialog is unavailable and no connection fields have been supplied,
|
|
|
28
28
|
openany-dev seller connections create --application APPLICATION_ID --operation OPERATION
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
If the user has already supplied any connection fields, keep the valid values, ask only for missing fields, and prepare `connection.json`. Set `label`, `baseUrl`, and `authType`. For `query` or `path` authentication, set `authParamName` as well. Keep credentials, query strings, and fragments out of the base URL. Use authorized `
|
|
31
|
+
If the user has already supplied any connection fields, keep the valid values, ask only for missing fields, and prepare `connection.json`. Set `label`, `baseUrl`, and `authType`. For `query` or `path` authentication, set `authParamName` as well. Keep credentials, query strings, and fragments out of the base URL. Use authorized `OPENANY_CONNECTION_API_KEY` injection or have the user pass the key through local stdin with hidden input. Use `authType: "none"` only when the service is confirmed to require no authentication.
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
34
|
openany-dev seller connections create --application APPLICATION_ID --operation OPERATION --file connection.json -j
|
|
@@ -1,8 +1,8 @@
|
|
|
1
|
-
#
|
|
1
|
+
# 选择连接
|
|
2
2
|
|
|
3
|
-
沿用已确认的 CLI、邮箱会话和供应商。Dev 环境将下方命令中的 `openany-dev` 替换为 `openany-dev
|
|
3
|
+
沿用已确认的 CLI、邮箱会话和供应商。Dev 环境将下方命令中的 `openany-dev` 替换为 `openany-dev`。需要绑定连接且用户尚未指定时,先单独问「这次要选择已有连接,还是新建连接?」等用户选择后进入对应分支。用户已明确选定连接或要求新建时,直接进入对应分支。
|
|
4
4
|
|
|
5
|
-
##
|
|
5
|
+
## 选择已有连接
|
|
6
6
|
|
|
7
7
|
按需列出该供应商已启用的连接,展示名称、Base URL 和认证方式,让用户选一条。已有无秘密的连接列表时直接复用;需要查看更多时,将回执的 `nextCursor` 传给 `--cursor`。确认没有可用连接后,询问是否新建。
|
|
8
8
|
|
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
openany-dev seller connections list --application APPLICATION_ID -j
|
|
11
11
|
```
|
|
12
12
|
|
|
13
|
-
核对所选连接归属当前供应商且已启用,记录 `id` 和 `revision`。已知 ID 且现有回执缺少必需字段时,按 ID 查详情。若连接的 Base URL
|
|
13
|
+
核对所选连接归属当前供应商且已启用,记录 `id` 和 `revision`。已知 ID 且现有回执缺少必需字段时,按 ID 查详情。若连接的 Base URL 或认证方式与已知服务信息冲突,先请用户确认。接口路径由资源配置提供,不能用它判断连接是否匹配。
|
|
14
14
|
|
|
15
|
-
##
|
|
15
|
+
## 新建连接
|
|
16
16
|
|
|
17
17
|
用户选择新建且尚未提供连接字段时,Agent 直接执行下方命令并等待弹框结果。弹框一次完成连接名称、Base URL、认证方式、必要的参数名和 API Key 的填写。弹框前只使用已确认的供应商 ID 和本次操作标识,跳过连接 schema 查询和连接字段提问。
|
|
18
18
|
|
|
@@ -20,7 +20,7 @@ openany-dev seller connections list --application APPLICATION_ID -j
|
|
|
20
20
|
openany-dev seller connections create --application APPLICATION_ID --operation OPERATION --gui -j
|
|
21
21
|
```
|
|
22
22
|
|
|
23
|
-
创建成功后使用回执中的 `id` 和 `revision`。回执缺必要字段时才回读;导入绑定使用连接 ID 作为 `
|
|
23
|
+
创建成功后使用回执中的 `id` 和 `revision`。回执缺必要字段时才回读;导入绑定使用连接 ID 作为 `connectionId`。弹框取消或超时时,保留当前任务进度,等待用户指示。
|
|
24
24
|
|
|
25
25
|
原生弹框不可用且尚未提供连接字段时,请用户在同一环境的本地交互终端运行下方命令。终端一次收集连接资料并隐藏 Key 输入;用户完成后只需提供连接 ID。
|
|
26
26
|
|
|
@@ -28,7 +28,7 @@ openany-dev seller connections create --application APPLICATION_ID --operation O
|
|
|
28
28
|
openany-dev seller connections create --application APPLICATION_ID --operation OPERATION
|
|
29
29
|
```
|
|
30
30
|
|
|
31
|
-
用户已提供部分或全部连接字段时,复用有效值,只补缺项,由 Agent 准备 `connection.json`。配置包含 `label`、`baseUrl` 和 `authType`,`query` 或 `path` 认证还需 `authParamName`。Base URL 不含凭据、查询串或片段。通过已授权的 `
|
|
31
|
+
用户已提供部分或全部连接字段时,复用有效值,只补缺项,由 Agent 准备 `connection.json`。配置包含 `label`、`baseUrl` 和 `authType`,`query` 或 `path` 认证还需 `authParamName`。Base URL 不含凭据、查询串或片段。通过已授权的 `OPENANY_CONNECTION_API_KEY` 注入,或请用户在本地使用隐藏输入将 Key 通过 stdin 传给 CLI。只有已确认无需认证时才使用 `authType: "none"`。
|
|
32
32
|
|
|
33
33
|
```bash
|
|
34
34
|
openany-dev seller connections create --application APPLICATION_ID --operation OPERATION --file connection.json -j
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## Shortest workflow
|
|
4
4
|
|
|
5
|
-
1. Follow the [connection workflow](connections.md) first. Confirm an enabled
|
|
5
|
+
1. Follow the [connection workflow](connections.md) first. Confirm an enabled connection owned by the supplier. Reuse a confirmed connection or ask the user to select or add one. Confirm the connection before requesting or reading source materials. Use the [bindings template](../templates/bindings.json) when creating or changing bindings.
|
|
6
6
|
2. Follow the [publishing workflow](publishing.md) to collect and read the resource URL, documentation, or file. Reuse a compliant file, and ask only about gaps or conflicts. Check the selected connection against the source base URL and authentication method. If they conflict, ask the user to confirm which connection to use.
|
|
7
|
-
3. Run the appropriate `preview` once. Include `--bindings-file bindings.json` if bindings are already available. Record the batch `id` and check `summary`, `stage`, `missingFields`, and `errorCode` for anything to supply. Preview only validates. It creates no resources and makes no
|
|
7
|
+
3. Run the appropriate `preview` once. Include `--bindings-file bindings.json` if bindings are already available. Record the batch `id` and check `summary`, `stage`, `missingFields`, and `errorCode` for anything to supply. Preview only validates. It creates no resources and makes no service calls.
|
|
8
8
|
4. Run `run` to create drafts. For bindings completed after preview, use the returned item IDs and submit them with `run --bindings-file bindings.json`. Read each item's status, `operation`, and `resourceId` from the receipt. If the user requested only drafts, report the result and stop. For verification or publication, apply the [publishing workflow](publishing.md) to each item.
|
|
9
9
|
|
|
10
10
|
```bash
|
|
@@ -17,7 +17,7 @@ Each batch can contain up to 100 items. JSON files can be up to 8 MiB. Use strin
|
|
|
17
17
|
|
|
18
18
|
### V2 standard API or Agent API file
|
|
19
19
|
|
|
20
|
-
If you already have a `provider-agent-api-v2` file, use its `apis` directly. To create a file from business materials, use the [standard API template](../templates/provider-agent-api-template.json) for a standard API or the [Agent API template](../templates/seller-agent-api-import-template.json) for Skill, Bot, Service, Data, or Goods. Preserve the selected [resource type](publishing.md) in `catalogType`. These resources require valid HTML body content in `includedContentHtml`, `usageInstructionsHtml`, and `effectContentHtml`, up to 32 KiB each. Standard APIs can omit them. For these imports, `apiDescription` must be at least 150 characters after trimming. The template's explanatory section is ignored during import. The API item ID is `METHOD /path` and the binding points to `
|
|
20
|
+
If you already have a `provider-agent-api-v2` file, use its `apis` directly. To create a file from business materials, use the [standard API template](../templates/provider-agent-api-template.json) for a standard API or the [Agent API template](../templates/seller-agent-api-import-template.json) for Skill, Bot, Service, Data, or Goods. Preserve the selected [resource type](publishing.md) in `catalogType`. These resources require valid HTML body content in `includedContentHtml`, `usageInstructionsHtml`, and `effectContentHtml`, up to 32 KiB each. Standard APIs can omit them. For these imports, `apiDescription` must be at least 150 characters after trimming. The template's explanatory section is ignored during import. The API item ID is `METHOD /path` and the binding points to `connectionId`.
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
23
|
openany-dev seller imports preview --type api --file api-v2.json --application ID -j
|
|
@@ -2,9 +2,9 @@
|
|
|
2
2
|
|
|
3
3
|
## 最短流程
|
|
4
4
|
|
|
5
|
-
1. 先按[中文连接流程](connections.zh-CN.md)
|
|
5
|
+
1. 先按[中文连接流程](connections.zh-CN.md)确认归属当前供应商且已启用的连接。复用已确认的连接,或请用户选择已有连接或新建。连接确认后再读取或索取资料。创建或修改绑定时使用[绑定模板](../templates/bindings.json)。
|
|
6
6
|
2. 按[上架流程](publishing.zh-CN.md)收集并读取资源网址、文档或文件。直接复用合规文件,仅补缺项或冲突。根据资料核对已选连接的 Base URL 和认证方式,如不匹配,先请用户确认适用的连接。
|
|
7
|
-
3. 执行对应分支的 `preview` 一次。已有绑定就带上 `--bindings-file bindings.json`。记录批次 `id`,从 `summary`、`stage`、`missingFields` 和 `errorCode`
|
|
7
|
+
3. 执行对应分支的 `preview` 一次。已有绑定就带上 `--bindings-file bindings.json`。记录批次 `id`,从 `summary`、`stage`、`missingFields` 和 `errorCode` 判断要补什么。预览只校验,不创建资源或调用服务。
|
|
8
8
|
4. 执行 `run` 创建草稿。预览后才补齐的绑定按返回项目 ID 填写,直接随 `run --bindings-file bindings.json` 提交。读取回执中的逐项状态、`operation` 和 `resourceId`。只要求草稿时报告结果即结束;需要验证或发布时按[上架流程](publishing.zh-CN.md)逐项处理。
|
|
9
9
|
|
|
10
10
|
```bash
|
|
@@ -17,7 +17,7 @@ openany-dev seller imports run --batch BATCH_ID --application ID -j
|
|
|
17
17
|
|
|
18
18
|
### V2 API 或服务文件
|
|
19
19
|
|
|
20
|
-
已有 `provider-agent-api-v2` 文件就直接用其中的 `apis`。从业务资料新建文件时,普通 API 用[普通 API 模板](../templates/provider-agent-api-template.json),Skill、Bot、Service、Data 和 Goods 用 [Agent API 模板](../templates/seller-agent-api-import-template.json),按[资源上架流程](publishing.zh-CN.md)保留所选的 `catalogType`。这些资源的 `includedContentHtml`、`usageInstructionsHtml`、`effectContentHtml` 均需有效 HTML 正文,每字段最多 32 KiB;普通 API 可省略。这些导入条目的 `apiDescription` 去掉首尾空白后至少 150 个字符。说明区不参与导入。API 项目 ID 为 `METHOD /path`,绑定指向 `
|
|
20
|
+
已有 `provider-agent-api-v2` 文件就直接用其中的 `apis`。从业务资料新建文件时,普通 API 用[普通 API 模板](../templates/provider-agent-api-template.json),Skill、Bot、Service、Data 和 Goods 用 [Agent API 模板](../templates/seller-agent-api-import-template.json),按[资源上架流程](publishing.zh-CN.md)保留所选的 `catalogType`。这些资源的 `includedContentHtml`、`usageInstructionsHtml`、`effectContentHtml` 均需有效 HTML 正文,每字段最多 32 KiB;普通 API 可省略。这些导入条目的 `apiDescription` 去掉首尾空白后至少 150 个字符。说明区不参与导入。API 项目 ID 为 `METHOD /path`,绑定指向 `connectionId`。
|
|
21
21
|
|
|
22
22
|
```bash
|
|
23
23
|
openany-dev seller imports preview --type api --file api-v2.json --application ID -j
|
|
@@ -9,9 +9,9 @@ openany-dev seller schema --type model --application APPLICATION_ID -j
|
|
|
9
9
|
openany-dev seller models create --application APPLICATION_ID --file model.json --operation TASK-model-create-1 -j
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
Prepare `model.json` against the current schema: `price` and `routes`, using the supplier's actual model identity, capabilities, quote, currency,
|
|
12
|
+
Prepare `model.json` against the current schema: `price` and `routes`, using the supplier's actual model identity, capabilities, quote, currency, service endpoints, mappings, and route choices. Prices are decimal strings with at most six fractional digits; token prices use the existing per-million-token unit. Bind routes to owned connection IDs and required connection revisions. Never copy response-only ownership, activation, or publication fields into a write payload. Record the returned `price.id` as `MODEL_ID`.
|
|
13
13
|
|
|
14
|
-
`price.model` is the supplier's
|
|
14
|
+
`price.model` is the supplier's service model ID. `routes[0].publicModel` is the OpenAny route model ID used in client requests. These may differ: for example, `price.model: "vendor-chat-v2"` and `routes[0].publicModel: "my-chat"`. Saving derives the route's service model from `price.model`; do not add a third writable identity. Editing either ID does not rename the other. Manage one route per model.
|
|
15
15
|
|
|
16
16
|
### Non-token pricing
|
|
17
17
|
|
|
@@ -37,7 +37,7 @@ If the live CLI schema disagrees with the current website fields (for example, m
|
|
|
37
37
|
openany-dev seller models get --application APPLICATION_ID --id MODEL_ID -j
|
|
38
38
|
```
|
|
39
39
|
|
|
40
|
-
Save `version`, `price.id`, and each route's `id`, `
|
|
40
|
+
Save `version`, `price.id`, and each route's `id`, `connectionId`, and `connectionRevision`. Use saved route IDs, not array indices or local import item IDs. Read `price.servicePath` to choose the authorized endpoint. If this is a draft-only task, report the draft ID and stop here.
|
|
41
41
|
|
|
42
42
|
## 3. Verify every route
|
|
43
43
|
|
|
@@ -50,8 +50,8 @@ For each route, create a separate non-secret verification file with these fields
|
|
|
50
50
|
| --- | --- |
|
|
51
51
|
| `expectedVersion` | Saved model `version` |
|
|
52
52
|
| `routeId` | Saved `routes[].id` for this route |
|
|
53
|
-
| `
|
|
54
|
-
| `endpointIndex` | Zero-based index of the selected endpoint in `price.
|
|
53
|
+
| `expectedConnectionRevision` | That route's current `connectionRevision`; recheck the connection if needed |
|
|
54
|
+
| `endpointIndex` | Zero-based index of the selected endpoint in `price.servicePath` |
|
|
55
55
|
| `request` | Authorized test request (`path`, `query`, `headers`, `body` as applicable), without credentials |
|
|
56
56
|
|
|
57
57
|
```bash
|
|
@@ -65,7 +65,7 @@ openany-dev seller models get --application APPLICATION_ID --id MODEL_ID --verif
|
|
|
65
65
|
{
|
|
66
66
|
"expectedVersion": "SAVED_MODEL_VERSION",
|
|
67
67
|
"routeId": "SAVED_ROUTE_ID",
|
|
68
|
-
"
|
|
68
|
+
"expectedConnectionRevision": 1,
|
|
69
69
|
"endpointIndex": 0,
|
|
70
70
|
"request": {
|
|
71
71
|
"path": {},
|
|
@@ -79,9 +79,9 @@ openany-dev seller models get --application APPLICATION_ID --id MODEL_ID --verif
|
|
|
79
79
|
}
|
|
80
80
|
```
|
|
81
81
|
|
|
82
|
-
Replace the version, route ID, revision, endpoint index and test body with the saved configuration and authorized test inputs. For models, `request.path` must be an empty object `{}` when supplied, never `"/v1/chat/completions"` or a nonempty parameter map. The actual URL path comes from `price.
|
|
82
|
+
Replace the version, route ID, revision, endpoint index and test body with the saved configuration and authorized test inputs. For models, `request.path` must be an empty object `{}` when supplied, never `"/v1/chat/completions"` or a nonempty parameter map. The actual URL path comes from `price.servicePath[endpointIndex]`. A string fails backend JSON decoding before URL construction or a service call; the CLI now rejects it locally. API path parameter objects are a separate contract. A generic 400 alone is not evidence that CLI permissions are insufficient or that verification requires the web UI.
|
|
83
83
|
|
|
84
|
-
Record the verification response `id` before querying it. Use a distinct operation/file for each route. A usable receipt has `state: "passed"`, is not stale, and matches this `modelId`, `modelVersion`, `routeId`, `
|
|
84
|
+
Record the verification response `id` before querying it. Use a distinct operation/file for each route. A usable receipt has `state: "passed"`, is not stale, and matches this `modelId`, `modelVersion`, `routeId`, `connectionId`, and `connectionRevision`. Testing may incur costs; obey the authorized scope and budget. Query an unfinished known receipt within the task deadline instead of repeating verify. For unknown outcomes, follow [recovery](reviews.md).
|
|
85
85
|
|
|
86
86
|
## 4. Publish
|
|
87
87
|
|
|
@@ -9,9 +9,9 @@ openany-dev seller schema --type model --application APPLICATION_ID -j
|
|
|
9
9
|
openany-dev seller models create --application APPLICATION_ID --file model.json --operation TASK-model-create-1 -j
|
|
10
10
|
```
|
|
11
11
|
|
|
12
|
-
按当前 schema 准备 `model.json` 的 `price` 和 `routes
|
|
12
|
+
按当前 schema 准备 `model.json` 的 `price` 和 `routes`。使用实际模型标识、能力、报价、币种、服务端点和映射。价格用最多六位小数的字符串。按 token 计价时沿用每百万 token 单位。绑定归属当前供应商的连接及其修订,省略仅在响应中提供的归属、启用和发布字段。记录返回的 `price.id` 为 `MODEL_ID`。
|
|
13
13
|
|
|
14
|
-
`price.model`
|
|
14
|
+
`price.model` 是供应商的服务模型 ID,`routes[0].publicModel` 是客户端使用的 OpenAny 路由模型 ID。两者可以不同,例如 `vendor-chat-v2` 和 `my-chat`。保存时从 `price.model` 得到路由的服务模型,每个模型管理一条路由。
|
|
15
15
|
|
|
16
16
|
### 非 token 计价
|
|
17
17
|
|
|
@@ -33,13 +33,13 @@ V2 导入的 `inputPrice` 和 `outputPrice` 分别映射到这两个价格字段
|
|
|
33
33
|
openany-dev seller models get --application APPLICATION_ID --id MODEL_ID -j
|
|
34
34
|
```
|
|
35
35
|
|
|
36
|
-
记录 `version`、`price.id` 和各路由的 `id`、`
|
|
36
|
+
记录 `version`、`price.id` 和各路由的 `id`、`connectionId`、`connectionRevision`。验证使用保存的路由 ID。按 `price.servicePath` 选择获授权的端点。只建草稿时报告 ID 后结束。
|
|
37
37
|
|
|
38
38
|
## 3. 验证每条路由
|
|
39
39
|
|
|
40
|
-
先核对已有回执。仅复用 `state: "passed"`、未过期且 `modelId`、`modelVersion`、`routeId`、`
|
|
40
|
+
先核对已有回执。仅复用 `state: "passed"`、未过期且 `modelId`、`modelVersion`、`routeId`、`connectionId` 和 `connectionRevision` 均匹配的结果。遇到运行中或结果未知的测试,先查询或核实。只有需要新验证且已获测试和费用授权时才运行一次。
|
|
41
41
|
|
|
42
|
-
每条路由分别准备验证数据和操作名。字段为当前 `expectedVersion`、保存的 `routeId`、当前 `
|
|
42
|
+
每条路由分别准备验证数据和操作名。字段为当前 `expectedVersion`、保存的 `routeId`、当前 `expectedConnectionRevision`、从 0 开始的 `endpointIndex` 和获授权的 `request`。`request` 可包含 `path`、`query`、`headers`、`body`,凭据由连接提供。模型的 `request.path` 如有填写,只能是空对象 `{}`,实际路径来自 `price.servicePath[endpointIndex]`。可用 `--file PATH` 或 `--input 'JSON'` 传入同一结构,二选一。通用 400 错误需核对具体报错,再判断原因。
|
|
43
43
|
|
|
44
44
|
```bash
|
|
45
45
|
openany-dev seller models verify --application APPLICATION_ID --id MODEL_ID --file route-verification.json --operation TASK-model-route1-test-1 -j
|
|
@@ -10,9 +10,9 @@ For a request to list a resource, if the request and already confirmed informati
|
|
|
10
10
|
|
|
11
11
|
For Skill, Bot, Service, Data, or Goods, use the [Agent API template](../templates/seller-agent-api-import-template.json) and [Imports](imports.md). Set `catalogType` to the selected type: `skill`, `bot`, `service`, `data`, or `digital`, respectively. The template's `service` value is an example.
|
|
12
12
|
|
|
13
|
-
When
|
|
13
|
+
When a connection is needed and still undecided, use the native form to choose an existing connection or add one. Follow [Connections](connections.md), reusing confirmed connections and using the secure dialog when no connection fields have been collected. For a connection-only task, stop once you confirm the ID and revision.
|
|
14
14
|
|
|
15
|
-
Confirm the required
|
|
15
|
+
Confirm the required connection before requesting or reading source materials. When the source is missing, open a separate **Source materials** form with the options applicable to the chosen type: resource or API documentation link, sanitized cURL, file upload, or absolute local path. If the form allows only three options, group the two file options and ask how to provide the file next. In the form prompt, show the matching [Agent API](../templates/seller-agent-api-import-template.json), [standard API](../templates/provider-agent-api-template.json), or [model](../templates/models-v2.json) template location and say: “The template location is provided here. If you do not have a copy, download the template, fill it in, then upload the completed file or enter its absolute path.” Use an accessible absolute URL or verified local absolute path. If the location is inaccessible, attach the template and name it in the form. For Agent API listings, point to `fieldGuide` and the examples in `apis[0]`. Ask for the chosen input separately if the form cannot collect it.
|
|
16
16
|
|
|
17
17
|
Read the chosen source and ask only about omissions or conflicts. Collect the included content, usage instructions, effect examples, and how the resource is delivered. If its delivery is unsupported by the CLI, explain the limitation before preparing a draft. Preserve the supplied methods, paths, mappings, and billing terms. Validate imports against the template. Fetch the schema once for direct creation.
|
|
18
18
|
|
|
@@ -32,7 +32,7 @@ Follow the [API and resource verification and publication workflow](apis.md) or
|
|
|
32
32
|
|
|
33
33
|
- If the session is missing or expired, or the identity changed, follow [Login](login.md), confirm the intended account and supplier, and explicitly resume. Do not switch identities or authentication methods silently.
|
|
34
34
|
- If the connection or commercial terms are missing, keep the draft or prepared inputs and report the specific missing fields. Do not switch authentication to `none` or fabricate credentials.
|
|
35
|
-
- Check the
|
|
35
|
+
- Check the service path only when publication reports an explicit service path error. For other conflicts, unknown results, admission errors, or publication errors, follow [Review results](reviews.md). Record error codes and resource or operation IDs while keeping secrets out of the report.
|
|
36
36
|
- Respect supplier admission and administrator permissions. Keep payment arrangements outside the onboarding workflow. Use the current version for authorized resource edits.
|
|
37
37
|
|
|
38
38
|
## Final report
|
|
@@ -1,4 +1,4 @@
|
|
|
1
|
-
# API / 模型 /
|
|
1
|
+
# API / 模型 / 资源上架与连接
|
|
2
2
|
|
|
3
3
|
沿用[主入口](../SKILL.zh-CN.md)确认的环境、账号和供应商,再收集资源资料。无可用供应商时,获授权后转入[供应商申请](application.zh-CN.md)。仅查历史审核时读[审核结果](reviews.zh-CN.md)。
|
|
4
4
|
|
|
@@ -10,9 +10,9 @@
|
|
|
10
10
|
|
|
11
11
|
Skill、Bot、Service、Data、Goods 使用 [Agent API 模板](../templates/seller-agent-api-import-template.json),走[导入流程](imports.zh-CN.md),并按用户选定类型将 `catalogType` 分别填写为 `skill`、`bot`、`service`、`data`、`digital`。模板中的 `service` 只是示例。
|
|
12
12
|
|
|
13
|
-
|
|
13
|
+
需要连接且用户未指定时,用原生表单选择复用已有连接或新建。按[连接流程](connections.zh-CN.md)复用已确认的连接,按录入进度选择安全弹框或补齐字段。仅建连接时,确认 ID 和修订即结束。
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
先确认本次需要的连接,再索取或读取资源资料。缺来源时,单独打开**资料来源**表单:按已选类型提供适用的资源或接口文档链接、脱敏 cURL、上传文件或本地绝对路径选项。表单最多支持三项时合并文件选项,下一步再问上传或路径。在表单题面显示对应的 [Agent API](../templates/seller-agent-api-import-template.json)、[普通 API](../templates/provider-agent-api-template.json)或[模型](../templates/models-v2.json)模板位置,并注明「这里已提供模板位置。如果你还没有模板,请先下载并填写,再上传填好的文件或输入本地绝对路径。」使用可访问的完整 URL 或已核实的本地绝对路径,位置不可访问时提供附件并在表单标出文件名。Agent API 资源请参考 `fieldGuide` 和 `apis[0]` 中的示例。表单无法接收所选资料时,再单独索取。
|
|
16
16
|
|
|
17
17
|
读取指定资料后只补问缺项或冲突,保留原方法、路径、映射和计费。收集交付内容、使用说明、效果示例和交付方式。如果 CLI 不支持该交付方式,建草稿前先说明限制。导入按模板校验,直接创建时取对应 schema 一次。
|
|
18
18
|
|
|
@@ -32,7 +32,7 @@ API 分类用顶层 `categories`,OpenAPI 导入写入元数据的 `configurati
|
|
|
32
32
|
|
|
33
33
|
- 登录缺失/过期或身份发生变化:遵循[身份认证](login.zh-CN.md),确认目标账号和供应商,然后明确恢复执行。不得静默切换身份或认证方式。
|
|
34
34
|
- 缺少连接或商业条款:保留草稿/已准备的输入,并报告具体缺失字段。不得将认证替换为 `none` 或编造凭据。
|
|
35
|
-
-
|
|
35
|
+
- 发布明确报服务路径错误时才核对路径。其他冲突、未知结果、准入或发布错误按[审核结果](reviews.zh-CN.md)处理。记录错误码和资源/操作 ID,勿泄露秘密。
|
|
36
36
|
- 不得绕过供应商准入、冒充管理员,或将安排付款作为接入流程的一部分。已获授权的资源编辑应使用当前版本。
|
|
37
37
|
|
|
38
38
|
## 最终报告
|
|
@@ -11,7 +11,7 @@ An operation is bound to its request method, target path and JSON payload within
|
|
|
11
11
|
| Failure | Required recovery |
|
|
12
12
|
| --- | --- |
|
|
13
13
|
| Create timed out or `OPERATION_UNCERTAIN` for a create | Retry the original create command with the identical file, original `--operation`, and `--resume`; the CLI reuses its original idempotency key. Do not create with a new name/key |
|
|
14
|
-
| Verification has a known ID | Query that exact ID with the model/API `get --verification-id` command; do not repeat the
|
|
14
|
+
| Verification has a known ID | Query that exact ID with the model/API `get --verification-id` command; do not repeat the service test |
|
|
15
15
|
| Verification timed out with no ID | Read the resource and any exposed verification information; do not assume the newest receipt is yours. If the CLI output cannot positively identify the original test, retain the unknown operation and request reconciliation. Model configuration reads do not guarantee exposure of verification receipts |
|
|
16
16
|
| Update or publication outcome unknown | Read current resource and reconcile against the original intent before another mutation. Do not replay an uncertain update, publication, or verification, even with `--resume` |
|
|
17
17
|
| Version conflict or stale verification | Read current resource and connections, understand the changed inputs, correct if authorized, and reverify within budget. Never merely replace version numbers |
|
|
@@ -19,4 +19,4 @@ An operation is bound to its request method, target path and JSON payload within
|
|
|
19
19
|
| `IDEMPOTENCY_CONFLICT` | Stop reusing that operation with changed input; reconcile the original outcome first |
|
|
20
20
|
| Login/session or supplier changed | Follow [authentication](auth.md) and confirm the intended identity before explicitly resuming |
|
|
21
21
|
|
|
22
|
-
A running/unknown/failed verification is never a pass. If a test cannot be reconciled, report the unresolved operation and stop that resource before publication; independent resources can continue. Preserve public error codes and IDs in the final report without copying secrets or
|
|
22
|
+
A running/unknown/failed verification is never a pass. If a test cannot be reconciled, report the unresolved operation and stop that resource before publication; independent resources can continue. Preserve public error codes and IDs in the final report without copying secrets or sensitive service responses.
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"schemaVersion":1,"items":[{"itemId":"GET /v1/example","
|
|
1
|
+
{"schemaVersion":1,"items":[{"itemId":"GET /v1/example","connectionId":"REPLACE_CONNECTION_ID"},{"itemId":"supplier-model-1","routes":[{"index":0,"connectionId":"REPLACE_CONNECTION_ID"}]}]}
|
|
@@ -8,7 +8,7 @@
|
|
|
8
8
|
"Enter amounts as strings in the currency specified by priceCurrency, with at most 6 decimal places.",
|
|
9
9
|
"When usageUnit (mapped to billingUnit) is not token, outputPrice (mapped to actualCompletion) must be the string \"0\", meaning actualCompletion must be 0.",
|
|
10
10
|
"In this example, inputPrice=\"1.000000\" means USD 1 per million input tokens.",
|
|
11
|
-
"Select the
|
|
11
|
+
"Select the connection on the import page. Never enter real API keys in this template.",
|
|
12
12
|
"Replace the domain, model ID, and route.provider in example requests with your actual configuration."
|
|
13
13
|
],
|
|
14
14
|
"timeExample": "UTC 01:00-04:00 corresponds to 09:00-12:00 China Standard Time (UTC+8)."
|
|
@@ -30,10 +30,10 @@
|
|
|
30
30
|
"constraints": "At least one item is required. The file must not exceed 2 MiB. Model identifiers must be unique."
|
|
31
31
|
},
|
|
32
32
|
"models[].modelId": {
|
|
33
|
-
"label": "
|
|
33
|
+
"label": "Service model ID",
|
|
34
34
|
"type": "string",
|
|
35
35
|
"required": true,
|
|
36
|
-
"description": "The model ID recognized by the
|
|
36
|
+
"description": "The model ID recognized by the service.",
|
|
37
37
|
"constraints": "A non-empty string.",
|
|
38
38
|
"example": "qwen3.8-max"
|
|
39
39
|
},
|
|
@@ -42,7 +42,7 @@
|
|
|
42
42
|
"type": "string",
|
|
43
43
|
"required": false,
|
|
44
44
|
"description": "The ID callers provide in the request's model field.",
|
|
45
|
-
"constraints": "Must be non-empty when provided. Defaults to the
|
|
45
|
+
"constraints": "Must be non-empty when provided. Defaults to the service model ID when omitted.",
|
|
46
46
|
"example": "openany-qwen3.8-max"
|
|
47
47
|
},
|
|
48
48
|
"models[].modelDescription": {
|
|
@@ -173,15 +173,15 @@
|
|
|
173
173
|
"example": 125000
|
|
174
174
|
},
|
|
175
175
|
"models[].endpoints": {
|
|
176
|
-
"label": "
|
|
176
|
+
"label": "Service endpoints",
|
|
177
177
|
"type": "array<object>",
|
|
178
178
|
"required": false,
|
|
179
|
-
"description": "Specify the
|
|
180
|
-
"constraints": "Each item contains operationType,
|
|
179
|
+
"description": "Specify the service endpoints used by the model.",
|
|
180
|
+
"constraints": "Each item contains operationType, servicePath, and httpMethod.",
|
|
181
181
|
"example": [
|
|
182
182
|
{
|
|
183
183
|
"operationType": "generations",
|
|
184
|
-
"
|
|
184
|
+
"servicePath": "/v1/chat/completions",
|
|
185
185
|
"httpMethod": "POST"
|
|
186
186
|
}
|
|
187
187
|
]
|
|
@@ -326,11 +326,11 @@
|
|
|
326
326
|
"constraints": "A non-empty string, such as generations.",
|
|
327
327
|
"example": "generations"
|
|
328
328
|
},
|
|
329
|
-
"models[].endpoints[].
|
|
330
|
-
"label": "
|
|
329
|
+
"models[].endpoints[].servicePath": {
|
|
330
|
+
"label": "Service endpoint path",
|
|
331
331
|
"type": "string",
|
|
332
332
|
"required": true,
|
|
333
|
-
"description": "Specify the path of the
|
|
333
|
+
"description": "Specify the path of the service request.",
|
|
334
334
|
"constraints": "Must start with / and must not include a domain.",
|
|
335
335
|
"example": "/v1/chat/completions"
|
|
336
336
|
},
|
|
@@ -506,7 +506,7 @@
|
|
|
506
506
|
"endpoints": [
|
|
507
507
|
{
|
|
508
508
|
"operationType": "generations",
|
|
509
|
-
"
|
|
509
|
+
"servicePath": "/v1/chat/completions",
|
|
510
510
|
"httpMethod": "POST"
|
|
511
511
|
}
|
|
512
512
|
],
|
|
@@ -3,8 +3,8 @@
|
|
|
3
3
|
"items": [{
|
|
4
4
|
"itemId": "supplier-model-1",
|
|
5
5
|
"configuration": {
|
|
6
|
-
"price": {"model": "
|
|
7
|
-
"routes": [{"publicModel": "REPLACE_OPENANY_ROUTE_MODEL_ID", "familyId": null, "
|
|
6
|
+
"price": {"model": "REPLACE_SERVICE_MODEL_ID", "description": "", "providerLogoUrl": "", "modelReleaseDate": null, "descriptionTranslations": {}, "modalities": [], "outModalities": [], "supportedFeatures": [], "contextWindowTokens": null, "maxOutputTokens": null, "servicePath": [], "bodySchema": {}, "curlExample": "", "currency": "USD", "billingType": "usage_flat", "billingUnit": "token", "actualPrompt": "REPLACE_QUOTE", "actualCompletion": "REPLACE_QUOTE"},
|
|
7
|
+
"routes": [{"publicModel": "REPLACE_OPENANY_ROUTE_MODEL_ID", "familyId": null, "connectionId": null, "status": "active", "matchRules": {}, "operations": []}]
|
|
8
8
|
}
|
|
9
9
|
}]
|
|
10
10
|
}
|
|
@@ -98,10 +98,10 @@
|
|
|
98
98
|
"example": "POST"
|
|
99
99
|
},
|
|
100
100
|
"apis[].publicPath": {
|
|
101
|
-
"label": "
|
|
101
|
+
"label": "Service API relative path",
|
|
102
102
|
"type": "string",
|
|
103
103
|
"required": true,
|
|
104
|
-
"description": "Enter the
|
|
104
|
+
"description": "Enter the service API's relative path. The public path is the same as the service path; the selected connection supplies the domain.",
|
|
105
105
|
"constraints": "Required; must start with /; at most 2048 characters; use {parameterName} for path parameters.",
|
|
106
106
|
"example": "/v1/text/process"
|
|
107
107
|
},
|
|
@@ -109,7 +109,7 @@
|
|
|
109
109
|
"label": "Request body format",
|
|
110
110
|
"type": "string",
|
|
111
111
|
"required": true,
|
|
112
|
-
"description": "Enter the request body encoding accepted by the
|
|
112
|
+
"description": "Enter the request body encoding accepted by the service API.",
|
|
113
113
|
"constraints": "Only none / application/json / application/x-www-form-urlencoded.",
|
|
114
114
|
"example": "application/json"
|
|
115
115
|
},
|
|
@@ -279,26 +279,26 @@
|
|
|
279
279
|
"example": []
|
|
280
280
|
},
|
|
281
281
|
"apis[].config.parameterMappings": {
|
|
282
|
-
"label": "
|
|
282
|
+
"label": "Service parameter mappings",
|
|
283
283
|
"type": "array<object>",
|
|
284
284
|
"required": true,
|
|
285
|
-
"description": "Forward caller parameters to specified
|
|
286
|
-
"constraints": "source references a declared parameter; target specifies
|
|
285
|
+
"description": "Forward caller parameters to specified service locations.",
|
|
286
|
+
"constraints": "source references a declared parameter; target specifies a service location.",
|
|
287
287
|
"example": []
|
|
288
288
|
},
|
|
289
289
|
"apis[].config.fixedHeaders": {
|
|
290
|
-
"label": "Fixed
|
|
290
|
+
"label": "Fixed service request headers",
|
|
291
291
|
"type": "object",
|
|
292
292
|
"required": false,
|
|
293
|
-
"description": "Enter non-sensitive headers added to every forwarded
|
|
293
|
+
"description": "Enter non-sensitive headers added to every forwarded service request.",
|
|
294
294
|
"constraints": "Values must be strings. Do not include credentials such as Authorization or Cookie, or reserved headers. Use {} if none.",
|
|
295
295
|
"example": {}
|
|
296
296
|
},
|
|
297
297
|
"apis[].config.fixedBody": {
|
|
298
|
-
"label": "Fixed
|
|
298
|
+
"label": "Fixed service request body fields",
|
|
299
299
|
"type": "object",
|
|
300
300
|
"required": false,
|
|
301
|
-
"description": "Enter JSON fields added to every forwarded
|
|
301
|
+
"description": "Enter JSON fields added to every forwarded service request.",
|
|
302
302
|
"constraints": "Enter a JSON object without secrets. Use {} if none.",
|
|
303
303
|
"example": {}
|
|
304
304
|
},
|
|
@@ -431,10 +431,10 @@
|
|
|
431
431
|
"example": "body:/text"
|
|
432
432
|
},
|
|
433
433
|
"apis[].config.parameterMappings[].target": {
|
|
434
|
-
"label": "
|
|
434
|
+
"label": "Service parameter target",
|
|
435
435
|
"type": "string",
|
|
436
436
|
"required": true,
|
|
437
|
-
"description": "Enter where the
|
|
437
|
+
"description": "Enter where the service API receives the parameter.",
|
|
438
438
|
"constraints": "For example, body:/text refers to the /text field in the JSON request body. An identical source and target forwards it without changing its location.",
|
|
439
439
|
"example": "body:/text"
|
|
440
440
|
},
|