Add LICENSE, AGENTS.md, and richer package metadata#1
Conversation
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: 8c2e4e5098
ℹ️ 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".
| ## Quick start | ||
|
|
||
| ```cpp | ||
| #include <uapi/client.hpp> |
There was a problem hiding this comment.
On case-sensitive platforms this quick start cannot compile because the repository ships include/uapi/Client.hpp and the existing README/tests include <uapi/Client.hpp>, not <uapi/client.hpp>. Since this AGENTS file is meant to guide generated integrations, agents following it will produce examples that fail before reaching the SDK code.
Useful? React with 👍 / 👎.
| auto weather = client.misc().get_misc_weather({.city = "北京"}); | ||
| std::cout << weather.dump() << std::endl; |
There was a problem hiding this comment.
This example describes a typed/snake_case API that is not present in the public wrapper: include/uapi/Client.hpp exposes getMiscWeather(const std::map<std::string, std::string>&) returning std::string, so get_misc_weather, the designated .city argument, and weather.dump() all fail for users or agents copying the snippet. The example should match the actual camelCase map-based calls used by the SDK.
Useful? React with 👍 / 👎.
| Methods throw `uapi::ApiException` on non-2xx responses. The exception | ||
| carries `code`, `error`, and `request_id` fields. Surface `error` |
There was a problem hiding this comment.
The public header does not define or throw uapi::ApiException; non-2xx responses are mapped to UapiError subclasses such as UnauthorizedError, NotFoundError, and finally UapiError in include/uapi/Client.hpp. Code generated from this guidance will try to catch a nonexistent public type and miss the fields that actually exist (code, status, payload, meta).
Useful? React with 👍 / 👎.
1 participant
Summary
Land explicit license terms, an agent-facing playbook, and discovery-friendly package metadata.
uapis.cnhomepage, search-friendly keywords / classifiers / tagsNo code changes; build/publish pipeline untouched.