Skip to content

Commit 437c808

Browse files
committed
docs: update readme
1 parent 546b384 commit 437c808

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

README.md

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,6 +28,12 @@ This SDK supports the following features:
2828
- Logging (non-auth) API requests, responses and errors.
2929
- Passing restricted data tokens to API clients.
3030

31+
## Packages
32+
33+
- [auth](https://www.github.com/bizon/selling-partner-api-sdk/tree/master/packages/auth): Authentication helpers for the Selling Partner API.
34+
- [common](https://www.github.com/bizon/selling-partner-api-sdk/tree/master/packages/common): Common utilities for the SDK.
35+
- [schemas](https://www.github.com/bizon/selling-partner-api-sdk/tree/master/packages/schemas): JSON schemas and TypeScript types for notifications, reports and feeds.
36+
3137
## Clients
3238

3339
This repository contains an API client for each of the available Selling Partner API version:
@@ -100,7 +106,7 @@ The API clients are automatically generated from the Swagger/OpenAPI models from
100106

101107
## Schemas
102108

103-
The SDK exposes notifications, reports and feeds schemas through `@sp-api-sdk/schemas`.
109+
The SDK exposes notifications, reports and feeds schemas through [`@sp-api-sdk/schemas`](https://www.github.com/bizon/selling-partner-api-sdk/tree/master/packages/schemas).
104110
It exposes the JSON schemas as well as typescript types.
105111

106112
For example, if you need the JSON schema for Vendor inventory reports:
@@ -121,6 +127,8 @@ const report = (await getVendorInventoryReportData()) as Reports.VendorInventory
121127

122128
## Code generation
123129

130+
To see the code generation process, see the [codegen](https://www.github.com/bizon/selling-partner-api-sdk/tree/master/codegen) module.
131+
124132
Some of the source Open API models are invalid (see the [issues](https://github.com/amzn/selling-partner-api-models/issues) and [PRs](https://github.com/amzn/selling-partner-api-models/pulls) on the Amazon repository), so this SDK defines some patches to account for those errors.
125133

126134
Each patch files are [JSON Patches](http://jsonpatch.com/) operations (1 logical change per file).

0 commit comments

Comments
 (0)