Skip to content

Commit

Permalink
[docs] Update README.md in api/ (aptos-labs#10764)
Browse files Browse the repository at this point in the history
  • Loading branch information
alinush authored Nov 2, 2023
1 parent ad50b99 commit 312e6f9
Showing 1 changed file with 1 addition and 0 deletions.
1 change: 1 addition & 0 deletions api/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ cargo run -p aptos-openapi-spec-generator -- -f json -o api/doc/spec.json
3. Regenerate the TypeScript SDK client files based upon the new API spec:
```
cd ecosystem/typescript/sdk
pnpm install
pnpm generate-client
```
4. Manually update the helper methods in the TypeScript SDK in: `ecosystem/typescript/sdk/src/aptos_client.ts`. Note: This is necessary because we wrap the generated client, so the docs on the methods in that file are written by hand. For example, if you change `/accounts/<addr>/resources` in the API, the `getAccountResources` method in the generated client will be different. You must therefore then change `getAccountResources` in `ecosystem/typescript/sdk/src/aptos_client.ts`, which wraps the generated method.
Expand Down

0 comments on commit 312e6f9

Please sign in to comment.