Meta
读取方法
读取一个平台方法的完整说明和 TypeScript 声明,公开、无需鉴权、不计费。
GET
/meta/v1/methods/{name}● 支持请求参数
namestring必填path: Exact method name from the search results, for example `praxis.database.databases.tables.create`.
返回
200
name 取自搜索结果,必须与方法名完全一致。声明不会被截断,字段名和枚举值请直接从中复制。未知名称返回 404 METHOD_NOT_FOUND,hint 列出最多三个相近的名称。
错误按 problem+json 格式返回,参见 错误码
响应
HTTP 200
The method with its complete declaration.
application/json
| 名称 | 类型 | 说明 |
|---|---|---|
| name | string | Method name, for example `praxis.agent.agents.list`. |
| summary | string | One-line statement of what the method does. |
| description | string | Full guidance for the method from the API reference, including when to use it, limits and error behaviour. May be empty for methods documented only by summary. |
| http | string | HTTP verb the method sends. |
| path | string | Public API path template with `{param}` placeholders. |
| declaration | string | Complete TypeScript signature, `name(args): Promise<Result>`. `args` carries `path`, `query`, `headers` and `body` members exactly as declared. Never truncated. |
| parameters | array<object> | Path, query and header parameters of the operation. |
| parameters[].name | string | Parameter name as sent on the wire. |
| parameters[].in | string | Where the parameter goes, one of `path`, `query` or `header`; maps to the matching member of `args`. |
| parameters[].required | boolean | Whether the call is rejected when the parameter is missing. |
| parameters[].description | string | Meaning, format and allowed values of the parameter. |
| parameters[].type | string | TypeScript type of the parameter value. |
| request_body | object | Request body expectations; null when the method takes no body. |
| request_body.required | boolean | Whether `args.body` must be supplied. |
| request_body.description | string | What the body carries. |
| request_body.content_types | array<string> | Media types the body may use; the first is the default. |
| responses | array<object> | Documented responses, successful and failed. |
| responses[].status | string | HTTP status code or `default`. |
| responses[].description | string | What the response means and what to do next. |
| responses[].content_types | array<string> | Media types the response may use. |