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

名称类型说明
namestringMethod name, for example `praxis.agent.agents.list`.
summarystringOne-line statement of what the method does.
descriptionstringFull 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.
httpstringHTTP verb the method sends.
pathstringPublic API path template with `{param}` placeholders.
declarationstringComplete TypeScript signature, `name(args): Promise<Result>`. `args` carries `path`, `query`, `headers` and `body` members exactly as declared. Never truncated.
parametersarray<object>Path, query and header parameters of the operation.
parameters[].namestringParameter name as sent on the wire.
parameters[].instringWhere the parameter goes, one of `path`, `query` or `header`; maps to the matching member of `args`.
parameters[].requiredbooleanWhether the call is rejected when the parameter is missing.
parameters[].descriptionstringMeaning, format and allowed values of the parameter.
parameters[].typestringTypeScript type of the parameter value.
request_bodyobjectRequest body expectations; null when the method takes no body.
request_body.requiredbooleanWhether `args.body` must be supplied.
request_body.descriptionstringWhat the body carries.
request_body.content_typesarray<string>Media types the body may use; the first is the default.
responsesarray<object>Documented responses, successful and failed.
responses[].statusstringHTTP status code or `default`.
responses[].descriptionstringWhat the response means and what to do next.
responses[].content_typesarray<string>Media types the response may use.