Python v4 SDKs now ship their own documentation. A README.md gets a developer started, api-reference.md and raw-api-reference.md document every operation, and sdk-map.md with a page per API group is a lookup index of the whole package.
Details
The README covers installation, constructing the synchronous and asynchronous clients with a placeholder credential for every declared authentication scheme, logging and best practices. The API reference documents each operation with a sync and an async sample, its parameter table, its response type and the errors it can raise. The raw API reference covers the same operations through with_raw_response, which returns an ApiResult instead of raising for an API error.
The SDK map is written for tools as much as people. It answers call-level questions such as an operation's signature, return type and errors by lookup, and for anything it does not carry, such as a model's shape or an enum's values, it names the one source file to read. A coding assistant can then ground its answers in the SDK you actually shipped rather than guessing from the specification.
Usage Example
The documentation lands at the root of the generated package, beside the source:
payments/
├── README.md # install, construct the client, configure logging
├── api-reference.md # every operation: samples, parameters, response, errors
├── raw-api-reference.md # the same operations through with_raw_response
├── sdk-map.md # lookup index of the whole Python surface
├── map/
│ └── operations/
│ ├── payments.md # one page per API group
│ └── refunds.md
├── pyproject.toml
├── LICENSE
└── payments/
├── client.py
├── async_client.py
├── apis/
├── models/
└── core/
The README links to both API references and to the SDK map, so a reader can start there.
This feature is available in the Python v4 SDK (beta). Generate it from the APIMatic CLI:
apimatic sdk generate --language=python --codegen-version=v4 --stability=beta
For the full set of flags and options, see the APIMatic CLI documentation.