diff options
author | August Skare <post@augustskare.no> | 2018-11-13 16:52:41 +0800 |
---|---|---|
committer | August Skare <post@augustskare.no> | 2018-11-13 16:52:41 +0800 |
commit | e43988aa44225ef66c95d0b26764de57b3d26c3a (patch) | |
tree | 5f2bdff05e3e6a336b600bcb7a766da4793afc76 /packages/sra-spec | |
parent | ee91f56bbe69534885da47f58a81302bf3c37f28 (diff) | |
parent | c41622c20aea8ba89dc9899ff8b3ab6f22f53503 (diff) | |
download | dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.gz dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.bz2 dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.lz dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.xz dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.tar.zst dexon-sol-tools-e43988aa44225ef66c95d0b26764de57b3d26c3a.zip |
Merge branch 'development' into dev-tools-pages
Diffstat (limited to 'packages/sra-spec')
-rw-r--r-- | packages/sra-spec/CHANGELOG.json | 19 | ||||
-rw-r--r-- | packages/sra-spec/CHANGELOG.md | 10 | ||||
-rw-r--r-- | packages/sra-spec/README.md | 8 | ||||
-rw-r--r-- | packages/sra-spec/package.json | 12 | ||||
-rw-r--r-- | packages/sra-spec/src/json-schemas.ts | 8 | ||||
-rw-r--r-- | packages/sra-spec/src/md/introduction.md | 4 | ||||
-rw-r--r-- | packages/sra-spec/tslint.json | 2 |
7 files changed, 44 insertions, 19 deletions
diff --git a/packages/sra-spec/CHANGELOG.json b/packages/sra-spec/CHANGELOG.json index 7657dd9ee..e053b3163 100644 --- a/packages/sra-spec/CHANGELOG.json +++ b/packages/sra-spec/CHANGELOG.json @@ -1,5 +1,24 @@ [ { + "version": "1.0.8", + "changes": [ + { + "note": "Dependencies updated" + } + ], + "timestamp": 1541740904 + }, + { + "version": "1.0.7", + "changes": [ + { + "note": "Make @loopback/openapi-v3-types a 'dependency' so it's available to users of the library", + "pr": 1105 + } + ], + "timestamp": 1539871071 + }, + { "version": "1.0.6", "changes": [ { diff --git a/packages/sra-spec/CHANGELOG.md b/packages/sra-spec/CHANGELOG.md index 4d27f20df..02d22431f 100644 --- a/packages/sra-spec/CHANGELOG.md +++ b/packages/sra-spec/CHANGELOG.md @@ -5,6 +5,14 @@ Edit the package's CHANGELOG.json file only. CHANGELOG +## v1.0.8 - _November 9, 2018_ + + * Dependencies updated + +## v1.0.7 - _October 18, 2018_ + + * Make @loopback/openapi-v3-types a 'dependency' so it's available to users of the library (#1105) + ## v1.0.6 - _October 4, 2018_ * Dependencies updated @@ -38,6 +46,6 @@ CHANGELOG * Add takerAddress to /orders parameters (#974) -## v1.0.1-rc.4 - _August 13, 2018_ +## v1.0.1-rc.4 - _August 14, 2018_ * Add inital spec for SRA v2 (#916) diff --git a/packages/sra-spec/README.md b/packages/sra-spec/README.md index 7eee6396b..4575aaf66 100644 --- a/packages/sra-spec/README.md +++ b/packages/sra-spec/README.md @@ -1,4 +1,4 @@ -## @0xproject/sra-spec +## @0x/sra-spec Contains the Standard Relayer API [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification). @@ -9,7 +9,7 @@ A deployed [ReDoc](https://github.com/Rebilly/ReDoc) static site with the API ca ## Usage ``` -import { api } from '@0xproject/sra-spec'; +import { api } from '@0x/sra-spec'; ``` ## Installation @@ -53,13 +53,13 @@ yarn install To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory: ```bash -PKG=@0xproject/sra-spec yarn build +PKG=@0x/sra-spec yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/sra-spec yarn watch +PKG=@0x/sra-spec yarn watch ``` ### Static Site diff --git a/packages/sra-spec/package.json b/packages/sra-spec/package.json index 6b4157699..e3b6ad979 100644 --- a/packages/sra-spec/package.json +++ b/packages/sra-spec/package.json @@ -1,6 +1,6 @@ { - "name": "@0xproject/sra-spec", - "version": "1.0.6", + "name": "@0x/sra-spec", + "version": "1.0.8", "engines": { "node": ">=6.12" }, @@ -10,7 +10,7 @@ "scripts": { "serve": "redoc-cli serve lib/api.json --watch", "watch_without_deps": "run-p build:watch serve", - "lint": "tslint --project .", + "lint": "tslint --format stylish --project .", "test": "swagger-cli validate lib/api.json", "rebuild_and_test": "run-s clean build test", "test:coverage": "nyc npm run test --all && yarn coverage:report:lcov", @@ -35,11 +35,11 @@ }, "homepage": "https://github.com/0xProject/0x-monorepo/packages/sra-spec/README.md", "dependencies": { - "@0xproject/json-schemas": "^1.0.7" + "@0x/json-schemas": "^2.0.1", + "@loopback/openapi-v3-types": "^0.8.2" }, "devDependencies": { - "@0xproject/tslint-config": "^1.0.8", - "@loopback/openapi-v3-types": "^0.8.2", + "@0x/tslint-config": "^1.0.10", "@types/mocha": "^2.2.42", "@types/node": "^10.5.3", "chai": "^4.0.1", diff --git a/packages/sra-spec/src/json-schemas.ts b/packages/sra-spec/src/json-schemas.ts index 173a04bfb..f9342ca9e 100644 --- a/packages/sra-spec/src/json-schemas.ts +++ b/packages/sra-spec/src/json-schemas.ts @@ -1,7 +1,8 @@ -import { schemas as jsonSchemas } from '@0xproject/json-schemas'; +import { schemas as jsonSchemas } from '@0x/json-schemas'; // Only include schemas we actually need const { + wholeNumberSchema, numberSchema, addressSchema, hexSchema, @@ -21,13 +22,14 @@ const { relayerApiAssetDataPairsResponseSchema, relayerApiAssetDataTradeInfoSchema, relayerApiOrdersChannelSubscribeSchema, - relayerApiOrdersChannelSubscribePayload, + relayerApiOrdersChannelSubscribePayloadSchema, relayerApiOrdersChannelUpdateSchema, relayerApiOrdersResponseSchema, relayerApiAssetDataPairsSchema, } = jsonSchemas; const usedSchemas = { + wholeNumberSchema, numberSchema, addressSchema, hexSchema, @@ -47,7 +49,7 @@ const usedSchemas = { relayerApiAssetDataPairsResponseSchema, relayerApiAssetDataTradeInfoSchema, relayerApiOrdersChannelSubscribeSchema, - relayerApiOrdersChannelSubscribePayload, + relayerApiOrdersChannelSubscribePayloadSchema, relayerApiOrdersChannelUpdateSchema, relayerApiOrdersResponseSchema, relayerApiAssetDataPairsSchema, diff --git a/packages/sra-spec/src/md/introduction.md b/packages/sra-spec/src/md/introduction.md index f27186f41..824df8998 100644 --- a/packages/sra-spec/src/md/introduction.md +++ b/packages/sra-spec/src/md/introduction.md @@ -1,7 +1,3 @@ -# Testing - -Use the [sra-report](https://github.com/0xProject/0x-monorepo/tree/development/packages/sra-report) command line tool to test your API for SRA compliance. - # 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). diff --git a/packages/sra-spec/tslint.json b/packages/sra-spec/tslint.json index ffaefe83a..dd9053357 100644 --- a/packages/sra-spec/tslint.json +++ b/packages/sra-spec/tslint.json @@ -1,3 +1,3 @@ { - "extends": ["@0xproject/tslint-config"] + "extends": ["@0x/tslint-config"] } |