diff options
author | F. Eugene Aumson <feuGeneA@users.noreply.github.com> | 2019-01-09 03:28:32 +0800 |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-01-09 03:28:32 +0800 |
commit | 4689f20b86333d74fa0ccd45b23c560a0a0361b5 (patch) | |
tree | 9b1810a912a7c866d6be3799b24feea9c9f49d1f /python-packages/sra_client | |
parent | de927d7207571e99a009320d9a47ae9815c2e198 (diff) | |
parent | e62e61bf7145c0a8011e098aa22168416d01a781 (diff) | |
download | dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.gz dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.bz2 dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.lz dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.xz dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.tar.zst dexon-sol-tools-4689f20b86333d74fa0ccd45b23c560a0a0361b5.zip |
Move json_schemas to its own package (#1435)
* Move zero_ex.json_schemas to its own package
* Support ALL the schemas
* Stop installing packages as editable
* HACK: cp files because CircleCI isn't
* Add example usage to sra_client README
* Tweak special case: only strip Schema as suffix
* Correct doc titles
* Clarify what kind of support ticket was raised.
* Correct inconsistencies in JSON schema names
In both ref ID's and file names.
* Add entry point for validation of JSON strings
Diffstat (limited to 'python-packages/sra_client')
-rw-r--r-- | python-packages/sra_client/README.md | 29 |
1 files changed, 29 insertions, 0 deletions
diff --git a/python-packages/sra_client/README.md b/python-packages/sra_client/README.md index ab3939b41..279fb41a4 100644 --- a/python-packages/sra_client/README.md +++ b/python-packages/sra_client/README.md @@ -6,6 +6,35 @@ A Python client for interacting with servers conforming to [the Standard Relayer The [JSON schemas](http://json-schema.org/) for the API payloads and responses can be found in [@0xproject/json-schemas](https://github.com/0xProject/0x.js/tree/development/packages/json-schemas). Examples of each payload and response can be found in the 0x.js library's [test suite](https://github.com/0xProject/0x.js/blob/development/packages/json-schemas/test/schema_test.ts#L1). +```bash +pip install 0x-json-schemas +``` + +You can easily validate your API's payloads and responses using the [0x-json-schemas](https://github.com/0xProject/0x.js/tree/development/python-packages/json_schemas) package: + +```python +from zero_ex.json_schemas import assert_valid +from zero_ex.order_utils import Order + +order: Order = { + 'makerAddress': "0x0000000000000000000000000000000000000000", + 'takerAddress': "0x0000000000000000000000000000000000000000", + 'feeRecipientAddress': "0x0000000000000000000000000000000000000000", + 'senderAddress': "0x0000000000000000000000000000000000000000", + 'makerAssetAmount': "1000000000000000000", + 'takerAssetAmount': "1000000000000000000", + 'makerFee': "0", + 'takerFee': "0", + 'expirationTimeSeconds': "12345", + 'salt': "12345", + 'makerAssetData': "0x0000000000000000000000000000000000000000", + 'takerAssetData': "0x0000000000000000000000000000000000000000", + 'exchangeAddress': "0x0000000000000000000000000000000000000000", +} + +assert_valid(order, "/orderSchema") +``` + # Pagination Requests that return potentially large collections should respond to the **?page** and **?perPage** parameters. For example: |