diff --git a/README.md b/README.md index a8bd7413e6..9e56dc475d 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,7 @@ If you're developing on 0x now or are interested in using 0x infrastructure in t | [`@0xproject/monorepo-scripts`](/packages/monorepo-scripts) | [![npm](https://img.shields.io/npm/v/@0xproject/monorepo-scripts.svg)](https://www.npmjs.com/package/@0xproject/monorepo-scripts) | Monorepo scripts | | [`@0xproject/react-docs`](/packages/react-docs) | [![npm](https://img.shields.io/npm/v/@0xproject/react-docs.svg)](https://www.npmjs.com/package/@0xproject/react-docs) | React documentation component for rendering TypeDoc & Doxity generated JSON | | [`@0xproject/react-shared`](/packages/react-shared) | [![npm](https://img.shields.io/npm/v/@0xproject/react-shared.svg)](https://www.npmjs.com/package/@0xproject/react-shared) | 0x shared react components | -| [`@0xproject/sra-api`](/packages/sra-api) | [![npm](https://img.shields.io/npm/v/@0xproject/sra-api.svg)](https://www.npmjs.com/package/@0xproject/sra-api) | OpenAPI specification for the standard relayer API | +| [`@0xproject/sra-spec`](/packages/sra-spec) | [![npm](https://img.shields.io/npm/v/@0xproject/sra-spec.svg)](https://www.npmjs.com/package/@0xproject/sra-spec) | OpenAPI specification for the standard relayer API | | [`@0xproject/sra-report`](/packages/sra-report) | [![npm](https://img.shields.io/npm/v/@0xproject/sra-report.svg)](https://www.npmjs.com/package/@0xproject/sra-report) | Generate reports for standard relayer API compliance | | [`@0xproject/sol-cov`](/packages/sol-cov) | [![npm](https://img.shields.io/npm/v/@0xproject/sol-cov.svg)](https://www.npmjs.com/package/@0xproject/sol-cov) | Solidity test coverage tool | | [`@0xproject/subproviders`](/packages/subproviders) | [![npm](https://img.shields.io/npm/v/@0xproject/subproviders.svg)](https://www.npmjs.com/package/@0xproject/subproviders) | Useful web3 subproviders (e.g LedgerSubprovider) | diff --git a/packages/sra-api/.discharge.json b/packages/sra-spec/.discharge.json similarity index 91% rename from packages/sra-api/.discharge.json rename to packages/sra-spec/.discharge.json index df2cce0f4c..80ede84f36 100644 --- a/packages/sra-api/.discharge.json +++ b/packages/sra-spec/.discharge.json @@ -1,5 +1,5 @@ { - "domain": "sra-api", + "domain": "sra-spec", "build_command": "yarn build-json", "upload_directory": "public", "index_key": "index.html", diff --git a/packages/sra-api/.npmignore b/packages/sra-spec/.npmignore similarity index 100% rename from packages/sra-api/.npmignore rename to packages/sra-spec/.npmignore diff --git a/packages/sra-api/CHANGELOG.json b/packages/sra-spec/CHANGELOG.json similarity index 100% rename from packages/sra-api/CHANGELOG.json rename to packages/sra-spec/CHANGELOG.json diff --git a/packages/sra-api/CHANGELOG.md b/packages/sra-spec/CHANGELOG.md similarity index 100% rename from packages/sra-api/CHANGELOG.md rename to packages/sra-spec/CHANGELOG.md diff --git a/packages/sra-api/README.md b/packages/sra-spec/README.md similarity index 86% rename from packages/sra-api/README.md rename to packages/sra-spec/README.md index dec66c498a..7eee6396b5 100644 --- a/packages/sra-api/README.md +++ b/packages/sra-spec/README.md @@ -1,15 +1,15 @@ -## @0xproject/sra-api +## @0xproject/sra-spec Contains the Standard Relayer API [OpenAPI Spec](https://github.com/OAI/OpenAPI-Specification). The package distributes both a javascript object version and a json version. -A deployed [ReDoc](https://github.com/Rebilly/ReDoc) static site with the API can be found here http://sra-api.s3-website-us-east-1.amazonaws.com/. +A deployed [ReDoc](https://github.com/Rebilly/ReDoc) static site with the API can be found here http://sra-spec.s3-website-us-east-1.amazonaws.com/. ## Usage ``` -import { api } from '@0xproject/sra-api'; +import { api } from '@0xproject/sra-spec'; ``` ## Installation @@ -53,18 +53,18 @@ 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-api yarn build +PKG=@0xproject/sra-spec yarn build ``` Or continuously rebuild on change: ```bash -PKG=@0xproject/sra-api yarn watch +PKG=@0xproject/sra-spec yarn watch ``` ### Static Site -We also [host a static HTML version of the docs on S3](http://sra-api.s3-website-us-east-1.amazonaws.com/) for easy sharing. +We also [host a static HTML version of the docs on S3](http://sra-spec.s3-website-us-east-1.amazonaws.com/) for easy sharing. To build and deploy the site run diff --git a/packages/sra-api/build_scripts/buildJson.ts b/packages/sra-spec/build_scripts/buildJson.ts similarity index 100% rename from packages/sra-api/build_scripts/buildJson.ts rename to packages/sra-spec/build_scripts/buildJson.ts diff --git a/packages/sra-api/package.json b/packages/sra-spec/package.json similarity index 97% rename from packages/sra-api/package.json rename to packages/sra-spec/package.json index a4a0a7b0b0..e52e727492 100644 --- a/packages/sra-api/package.json +++ b/packages/sra-spec/package.json @@ -1,5 +1,5 @@ { - "name": "@0xproject/sra-api", + "name": "@0xproject/sra-spec", "version": "1.0.1-rc.4", "engines": { "node": ">=6.12" @@ -31,7 +31,7 @@ "bugs": { "url": "https://github.com/0xProject/0x-monorepo/issues" }, - "homepage": "https://github.com/0xProject/0x-monorepo/packages/sra-api/README.md", + "homepage": "https://github.com/0xProject/0x-monorepo/packages/sra-spec/README.md", "dependencies": { "@0xproject/json-schemas": "^1.0.1-rc.4" }, diff --git a/packages/sra-api/public/api.json b/packages/sra-spec/public/api.json similarity index 100% rename from packages/sra-api/public/api.json rename to packages/sra-spec/public/api.json diff --git a/packages/sra-api/public/index.html b/packages/sra-spec/public/index.html similarity index 100% rename from packages/sra-api/public/index.html rename to packages/sra-spec/public/index.html diff --git a/packages/sra-api/src/api.ts b/packages/sra-spec/src/api.ts similarity index 100% rename from packages/sra-api/src/api.ts rename to packages/sra-spec/src/api.ts diff --git a/packages/sra-api/src/errors.ts b/packages/sra-spec/src/errors.ts similarity index 100% rename from packages/sra-api/src/errors.ts rename to packages/sra-spec/src/errors.ts diff --git a/packages/sra-api/src/examples/errors.ts b/packages/sra-spec/src/examples/errors.ts similarity index 100% rename from packages/sra-api/src/examples/errors.ts rename to packages/sra-spec/src/examples/errors.ts diff --git a/packages/sra-api/src/examples/index.ts b/packages/sra-spec/src/examples/index.ts similarity index 100% rename from packages/sra-api/src/examples/index.ts rename to packages/sra-spec/src/examples/index.ts diff --git a/packages/sra-api/src/examples/relayerApiAssetDataPairsResponse.ts b/packages/sra-spec/src/examples/relayerApiAssetDataPairsResponse.ts similarity index 100% rename from packages/sra-api/src/examples/relayerApiAssetDataPairsResponse.ts rename to packages/sra-spec/src/examples/relayerApiAssetDataPairsResponse.ts diff --git a/packages/sra-api/src/examples/relayerApiFeeRecipientsResponse.ts b/packages/sra-spec/src/examples/relayerApiFeeRecipientsResponse.ts similarity index 100% rename from packages/sra-api/src/examples/relayerApiFeeRecipientsResponse.ts rename to packages/sra-spec/src/examples/relayerApiFeeRecipientsResponse.ts diff --git a/packages/sra-api/src/examples/relayerApiOrder.ts b/packages/sra-spec/src/examples/relayerApiOrder.ts similarity index 100% rename from packages/sra-api/src/examples/relayerApiOrder.ts rename to packages/sra-spec/src/examples/relayerApiOrder.ts diff --git a/packages/sra-api/src/examples/relayerApiOrderConfigPayload.ts b/packages/sra-spec/src/examples/relayerApiOrderConfigPayload.ts similarity index 100% rename from packages/sra-api/src/examples/relayerApiOrderConfigPayload.ts rename to packages/sra-spec/src/examples/relayerApiOrderConfigPayload.ts diff --git a/packages/sra-api/src/examples/relayerApiOrderConfigResponse.ts b/packages/sra-spec/src/examples/relayerApiOrderConfigResponse.ts similarity index 100% rename from packages/sra-api/src/examples/relayerApiOrderConfigResponse.ts rename to packages/sra-spec/src/examples/relayerApiOrderConfigResponse.ts diff --git a/packages/sra-api/src/examples/relayerApiOrderbookResponse.ts b/packages/sra-spec/src/examples/relayerApiOrderbookResponse.ts similarity index 100% rename from packages/sra-api/src/examples/relayerApiOrderbookResponse.ts rename to packages/sra-spec/src/examples/relayerApiOrderbookResponse.ts diff --git a/packages/sra-api/src/examples/relayerApiOrdersResponse.ts b/packages/sra-spec/src/examples/relayerApiOrdersResponse.ts similarity index 100% rename from packages/sra-api/src/examples/relayerApiOrdersResponse.ts rename to packages/sra-spec/src/examples/relayerApiOrdersResponse.ts diff --git a/packages/sra-api/src/examples/signedOrder.ts b/packages/sra-spec/src/examples/signedOrder.ts similarity index 100% rename from packages/sra-api/src/examples/signedOrder.ts rename to packages/sra-spec/src/examples/signedOrder.ts diff --git a/packages/sra-api/src/headers.ts b/packages/sra-spec/src/headers.ts similarity index 100% rename from packages/sra-api/src/headers.ts rename to packages/sra-spec/src/headers.ts diff --git a/packages/sra-api/src/index.ts b/packages/sra-spec/src/index.ts similarity index 100% rename from packages/sra-api/src/index.ts rename to packages/sra-spec/src/index.ts diff --git a/packages/sra-api/src/json-schemas.ts b/packages/sra-spec/src/json-schemas.ts similarity index 100% rename from packages/sra-api/src/json-schemas.ts rename to packages/sra-spec/src/json-schemas.ts diff --git a/packages/sra-api/src/md/index.ts b/packages/sra-spec/src/md/index.ts similarity index 100% rename from packages/sra-api/src/md/index.ts rename to packages/sra-spec/src/md/index.ts diff --git a/packages/sra-api/src/md/introduction.md b/packages/sra-spec/src/md/introduction.md similarity index 100% rename from packages/sra-api/src/md/introduction.md rename to packages/sra-spec/src/md/introduction.md diff --git a/packages/sra-api/src/parameters.ts b/packages/sra-spec/src/parameters.ts similarity index 100% rename from packages/sra-api/src/parameters.ts rename to packages/sra-spec/src/parameters.ts diff --git a/packages/sra-api/src/responses.ts b/packages/sra-spec/src/responses.ts similarity index 100% rename from packages/sra-api/src/responses.ts rename to packages/sra-spec/src/responses.ts diff --git a/packages/sra-api/tsconfig.json b/packages/sra-spec/tsconfig.json similarity index 100% rename from packages/sra-api/tsconfig.json rename to packages/sra-spec/tsconfig.json diff --git a/packages/sra-api/tslint.json b/packages/sra-spec/tslint.json similarity index 100% rename from packages/sra-api/tslint.json rename to packages/sra-spec/tslint.json