diff options
| author | Fabio Berger <me@fabioberger.com> | 2019-01-12 00:12:55 +0800 |
|---|---|---|
| committer | Fabio Berger <me@fabioberger.com> | 2019-01-12 00:12:55 +0800 |
| commit | 96ff5eef644b8c4d3f8fc4ec53270991fb51f121 (patch) | |
| tree | 530f43b03d2b3aa09b5f6552d4285df92d45fed0 /packages/sra-spec | |
| parent | 7f5a2c972bb86df77c423fb7029e9a629ecc1ede (diff) | |
| parent | 2cf57a48dd2857dd5cf2f31f4c60dd47ae4d34a5 (diff) | |
| download | dexon-0x-contracts-96ff5eef644b8c4d3f8fc4ec53270991fb51f121.tar.gz dexon-0x-contracts-96ff5eef644b8c4d3f8fc4ec53270991fb51f121.tar.zst dexon-0x-contracts-96ff5eef644b8c4d3f8fc4ec53270991fb51f121.zip | |
merge development
Diffstat (limited to 'packages/sra-spec')
| -rw-r--r-- | packages/sra-spec/CHANGELOG.json | 3 | ||||
| -rw-r--r-- | packages/sra-spec/src/md/introduction.md | 12 |
2 files changed, 7 insertions, 8 deletions
diff --git a/packages/sra-spec/CHANGELOG.json b/packages/sra-spec/CHANGELOG.json index fe52a8111..7132d098f 100644 --- a/packages/sra-spec/CHANGELOG.json +++ b/packages/sra-spec/CHANGELOG.json @@ -130,8 +130,7 @@ "version": "1.0.1-rc.6", "changes": [ { - "note": - "Fix `main` and `types` package.json entries so that they point to the new location of index.d.ts and index.js" + "note": "Fix `main` and `types` package.json entries so that they point to the new location of index.d.ts and index.js" }, { "note": "Fix relative path to introduction MD file" diff --git a/packages/sra-spec/src/md/introduction.md b/packages/sra-spec/src/md/introduction.md index 824df8998..3f7431c51 100644 --- a/packages/sra-spec/src/md/introduction.md +++ b/packages/sra-spec/src/md/introduction.md @@ -1,12 +1,12 @@ # Schemas -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 library's [test suite](https://github.com/0xProject/0x.js/blob/development/packages/json-schemas/test/schema_test.ts#L1). +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-monorepo/tree/development/packages/json-schemas). Examples of each payload and response can be found in the library's [test suite](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/test/schema_test.ts#L1). ```bash npm install @0xproject/json-schemas --save ``` -You can easily validate your API's payloads and responses using the [@0xproject/json-schemas](https://github.com/0xProject/0x.js/tree/development/packages/json-schemas) package: +You can easily validate your API's payloads and responses using the [@0xproject/json-schemas](https://github.com/0xProject/0x-monorepo/tree/development/packages/json-schemas) package: ```js import {SchemaValidator, ValidatorResult, schemas} from '@0xproject/json-schemas'; @@ -204,7 +204,7 @@ A good example of such a field is `remainingTakerAssetAmount`, which is a conven # Misc. -* All requests and responses should be of **application/json** content type -* All token amounts are sent in amounts of the smallest level of precision (base units). (e.g if a token has 18 decimal places, selling 1 token would show up as selling `'1000000000000000000'` units by this API). -* All addresses are sent as lower-case (non-checksummed) Ethereum addresses with the `0x` prefix. -* All parameters are to be written in `lowerCamelCase`. +- All requests and responses should be of **application/json** content type +- All token amounts are sent in amounts of the smallest level of precision (base units). (e.g if a token has 18 decimal places, selling 1 token would show up as selling `'1000000000000000000'` units by this API). +- All addresses are sent as lower-case (non-checksummed) Ethereum addresses with the `0x` prefix. +- All parameters are to be written in `lowerCamelCase`. |