diff options
author | fragosti <francesco.agosti93@gmail.com> | 2018-08-23 03:04:03 +0800 |
---|---|---|
committer | fragosti <francesco.agosti93@gmail.com> | 2018-08-23 03:04:03 +0800 |
commit | 74e7fa13d634d5410374ff2d5052a7c80841041d (patch) | |
tree | d13cc7f1c357b4f17a3dce00bd4c4563e0ecf94a /packages/website | |
parent | c905b20ce69d64711126bc31318e24f76deb05af (diff) | |
download | dexon-sol-tools-74e7fa13d634d5410374ff2d5052a7c80841041d.tar dexon-sol-tools-74e7fa13d634d5410374ff2d5052a7c80841041d.tar.gz dexon-sol-tools-74e7fa13d634d5410374ff2d5052a7c80841041d.tar.bz2 dexon-sol-tools-74e7fa13d634d5410374ff2d5052a7c80841041d.tar.lz dexon-sol-tools-74e7fa13d634d5410374ff2d5052a7c80841041d.tar.xz dexon-sol-tools-74e7fa13d634d5410374ff2d5052a7c80841041d.tar.zst dexon-sol-tools-74e7fa13d634d5410374ff2d5052a7c80841041d.zip |
Add documentation for json-schemas
Diffstat (limited to 'packages/website')
-rw-r--r-- | packages/website/md/docs/json_schemas/2.0.0/schemas.md | 29 | ||||
-rw-r--r-- | packages/website/ts/containers/json_schemas_documentation.ts | 7 |
2 files changed, 36 insertions, 0 deletions
diff --git a/packages/website/md/docs/json_schemas/2.0.0/schemas.md b/packages/website/md/docs/json_schemas/2.0.0/schemas.md new file mode 100644 index 000000000..c0494cc11 --- /dev/null +++ b/packages/website/md/docs/json_schemas/2.0.0/schemas.md @@ -0,0 +1,29 @@ +0x Protocol Schemas + +* [Basic types](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/basic_type_schemas.ts) (e.g Ethereum address, number, hex) +<!-- * [ECSignature](https://github.com/0xProject/0x-monorepo/blob/d4c1b3b0bd26e730ce6687469cdf7283877543e1/packages/json-schemas/schemas/ec_signature_schema.ts) --> +* [Order/SignedOrder](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/order_schemas.ts) +* [OrderHash](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/order_hash_schema.ts) + +0x.js Schemas + +* [BlockRange](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/block_range_schema.ts) +* [IndexFilter Values](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/index_filter_values_schema.ts) +* [OrderFillRequests](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/order_fill_requests_schema.ts) +* [OrderCancellationRequests](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/order_cancel_schema.ts) +* [OrderFillOrKillRequests](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/order_fill_or_kill_requests_schema.ts) +* [SignedOrders](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/signed_orders_schema.ts) +* [Token](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/token_schema.ts) +* [TxData](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/tx_data_schema.ts) + +Standard Relayer API Schemas + +* [Paginated collection](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/paginated_collection_schema.ts) +* [Error response](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/relayer_api_error_response_schema.ts) +* [Order config payload](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/relayer_api_order_config_payload_schema.ts) +* [Order config response](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/relayer_api_order_config_response_schema.ts) +* [Orders channel subscribe](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/relayer_api_orders_channel_subscribe_schema.ts) +* [Orders channel update](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/relayer_api_orders_channel_update_response_schema.ts) +* [Orderbook response](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/relayer_api_orderbook_response_schema.ts) +* [Asset pairs response](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/relayer_api_asset_pairs_response_schema.ts) +* [Fee recipients response](https://github.com/0xProject/0x-monorepo/blob/development/packages/json-schemas/schemas/relayer_api_fee_recipients_response_schema.ts)
\ No newline at end of file diff --git a/packages/website/ts/containers/json_schemas_documentation.ts b/packages/website/ts/containers/json_schemas_documentation.ts index 523777114..fe95320a9 100644 --- a/packages/website/ts/containers/json_schemas_documentation.ts +++ b/packages/website/ts/containers/json_schemas_documentation.ts @@ -13,6 +13,7 @@ const IntroMarkdownV1 = require('md/docs/json_schemas/1.0.0/introduction'); const InstallationMarkdownV1 = require('md/docs/json_schemas/1.0.0/installation'); const UsageMarkdownV1 = require('md/docs/json_schemas/1.0.0/usage'); const SchemasMarkdownV1 = require('md/docs/json_schemas/1.0.0/schemas'); +const SchemasMarkdownV2 = require('md/docs/json_schemas/2.0.0/schemas'); /* tslint:enable:no-var-requires */ const docSections = { @@ -42,6 +43,12 @@ const docsInfoConfig: DocsInfoConfig = { [docSections.schemas]: SchemasMarkdownV1, [docSections.usage]: UsageMarkdownV1, }, + '1.0.0': { + [docSections.introduction]: IntroMarkdownV1, + [docSections.installation]: InstallationMarkdownV1, + [docSections.schemas]: SchemasMarkdownV2, + [docSections.usage]: UsageMarkdownV1, + }, }, sectionNameToModulePath: { [docSections.schemaValidator]: ['"json-schemas/src/schema_validator"'], |