Add LICENSE, AGENTS.md, and richer package.json metadata#2
Conversation
Make the published npm package easier to discover and consume: - LICENSE (MIT) so the published tarball ships with explicit terms. - AGENTS.md is the dedicated agent-facing playbook covering install, the typed client surface, auth, error handling, and rate limits. - package.json gains an English description, license=MIT, an uapis.cn homepage, an issues URL, and npm-search-friendly keywords (uapi, uapis.cn, sdk, typescript, public-api, openapi, ...). No code changes; build/publish pipeline is unaffected. Co-Authored-By: Devin AI <158243242+devin-ai-integration[bot]@users.noreply.github.com>
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 0817c9e417
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
|
||
| Every method throws an `AxiosError`-shaped error on non-2xx responses. The | ||
| error body is a JSON object: `{code, success: false, error, request_id?}`. |
There was a problem hiding this comment.
For non-2xx responses this SDK does not expose an AxiosError-shaped object: HTTP.request catches Axios responses, maps them with mapError, and throws a UapiError subclass with code, status, details, payload, and meta. Agents following this guidance will generate handlers that read Axios fields like error.response.data, which are absent on the thrown SDK errors and will lose the real API error details.
Useful? React with 👍 / 👎.
2 participants
Summary
Land explicit license terms, an agent-facing playbook, and search-friendly npm metadata so the published
uapi-sdk-typescriptpackage surfaces well in npm search and AI-agent tooling.client.misc.getMiscWeather, ...), auth, errors, rate limits, links to sibling reposuapis.cnhomepage, issues URL, keywords (uapi, sdk, typescript, public-api, openapi, ...)No code changes; build/publish pipeline untouched.
Review & Testing Checklist for Human
npm publishfor next version picks up the new metadata