PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

2.0.4

npm

@0x/sra-spec

Standard Relayer API Open API Spec

Published25 Feb 2019
Direct dependencies19
Transitive dependenciesNot calculated

README

Current package documentation

@0x/sra-spec

Contains the Standard Relayer API OpenAPI Spec.

The package distributes both a javascript object version and a json version.

A deployed ReDoc static site with the API can be found here http://sra-spec.s3-website-us-east-1.amazonaws.com/.

Usage

import { api } from '@0x/sra-spec';

Installation

yarn install

Development

You can start a development server that will serve a ReDoc documentation instance. It uses the api.json file from lib/ (you must have built at least once with yarn build or yarn build-json) that is based on the api object exported from src.

yarn watch_without_deps

The process will watch for changes, but will not hot-reload so you must refresh the page to see the changes.

Contributing

We welcome improvements and fixes from the wider community! To report bugs within this package, please create an issue in this repository.

Please read our contribution guidelines before getting started.

Install dependencies

If you don't have yarn workspaces enabled (Yarn < v1.0) - enable them:

yarn config set workspaces-experimental true

Then install dependencies

yarn install

Build

To build this package and all other monorepo packages that it depends on, run the following from the monorepo root directory:

PKG=@0x/sra-spec yarn build

Or continuously rebuild on change:

PKG=@0x/sra-spec yarn watch

Static Site

We also host a static HTML version of the docs on S3 for easy sharing.

To build and deploy the site run

yarn deploy-site

NOTE: On deploying the site, it will say the site is available at a non-existent URL. Please ignore and use the (now updated) URL above.

Clean

yarn clean

Lint

yarn lint

Run Tests

yarn test

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 19

Native requirements
19 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
@0x/json-schemas
Environment
{
  "local_name": "@0x/json-schemas",
  "alias": false,
  "peer_metadata": null
}
^3.0.4runtime
@loopback/openapi-v3-types
Environment
{
  "local_name": "@loopback/openapi-v3-types",
  "alias": false,
  "peer_metadata": null
}
^0.8.2runtime
nyc
Environment
{
  "local_name": "nyc",
  "alias": false,
  "peer_metadata": null
}
^11.0.1development
shx
Environment
{
  "local_name": "shx",
  "alias": false,
  "peer_metadata": null
}
^0.2.2development
chai
Environment
{
  "local_name": "chai",
  "alias": false,
  "peer_metadata": null
}
^4.0.1development
mocha
Environment
{
  "local_name": "mocha",
  "alias": false,
  "peer_metadata": null
}
^4.1.0development
tslint
Environment
{
  "local_name": "tslint",
  "alias": false,
  "peer_metadata": null
}
5.11.0development
ts-node
Environment
{
  "local_name": "ts-node",
  "alias": false,
  "peer_metadata": null
}
^7.0.0development
copyfiles
Environment
{
  "local_name": "copyfiles",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
discharge
Environment
{
  "local_name": "discharge",
  "alias": false,
  "peer_metadata": null
}
^0.7.1development
redoc-cli
Environment
{
  "local_name": "redoc-cli",
  "alias": false,
  "peer_metadata": null
}
^0.6.1development
dirty-chai
Environment
{
  "local_name": "dirty-chai",
  "alias": false,
  "peer_metadata": null
}
^2.0.1development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
3.0.1development
@types/node
Environment
{
  "local_name": "@types/node",
  "alias": false,
  "peer_metadata": null
}
*development
npm-run-all
Environment
{
  "local_name": "npm-run-all",
  "alias": false,
  "peer_metadata": null
}
^4.1.2development
swagger-cli
Environment
{
  "local_name": "swagger-cli",
  "alias": false,
  "peer_metadata": null
}
^2.1.1development
@types/mocha
Environment
{
  "local_name": "@types/mocha",
  "alias": false,
  "peer_metadata": null
}
^2.2.42development
chokidar-cli
Environment
{
  "local_name": "chokidar-cli",
  "alias": false,
  "peer_metadata": null
}
^1.2.0development
@0x/tslint-config
Environment
{
  "local_name": "@0x/tslint-config",
  "alias": false,
  "peer_metadata": null
}
^3.0.0development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "a9dc2b578dfcc0ce9e5f07890954b39601b36e24",
  "tarball": "https://registry.npmjs.org/@0x/sra-spec/-/sra-spec-2.0.4.tgz",
  "fileCount": 91,
  "integrity": "sha512-ogZ61AEu3yzrxsfiHPHKSgZwcfnQPLGhEV0WFxukJv/SS24LxfYUXrpt5UeoeK7CCRXgUBmzbZIDyoJKG808lw==",
  "signatures": [
    {
      "sig": "MEYCIQDkDQF2IAjcRysPVZD3jDqUjYKjLI6gn3sJ9/PeuXKksgIhANthh4jVL3EhqNuJWGHrIvMnyjrHfe4zyvjmiqYCtTXH",
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"
    }
  ],
  "unpackedSize": 126203,
  "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJcdF+4CRA9TVsSAnZWagAAwfoQAIcrog9WEpqxfz7x3ySK\n3mjsTPnH1DuKdwzwg16Bsm8gnbrkvHFbBzxWsHqwcQHM5ml6PfurAQhS1By8\n6O4eMQ4GGMWIWP935Fu/hmPZWrM+a+KPxf0GrR403JQ1WLBa2Rnt5mCyH82D\ntDQcrbZuNkhTVDoXTULpn0GmsDkYMmX2VamMGsNWTumFv6Szryj06Uhr9hfV\n7j1Z4NOLd242+z3BCnSJ4uyFjO0LqO8M2dT+VqN/skVHmzHfq7BxiZcd1Mpu\nmlVwK9JrWFK6rqHKrDSY/FjCaRz2cuuxuQmMgArPSH3nH+Z4JGTyWh2ZX0Um\ncmkO3XNcKc08PWzvRZEE8KCLD2G8AAM6FGn+uSgb8iHxTVg7+7AXOmf4Z0MP\nosgJtur4fzMdZFvAtIjmTss3wbgwJZ4oUmZZhB1/ht2SJ6/mqWEHbhODPXO3\n7wfXLLdT/y9M4V2rMct0A+pvZvlUAcg61Ywgm7tVjPRMIWUU/8LbI8Q4BOfx\nA28mbWGQbDMQ1oxl5+LOxdkYqkO4+n17HeI9/zj76FlmT2PiQPvG1jBsIM/y\njq2+w79ftbKyJYN8k0IdKZqlOp3Ifd1Lern2yR15G+IoMzl1lsM4sUK2nVsT\nL6HLtMUsI5PX3prQph1q/8U+tYseHT6id3WrZFG4MfS0W/JR2CypDSQ1YKlK\nK+G8\r\n=gTRk\r\n-----END PGP SIGNATURE-----\r\n"
}

Repository

PENDING
0xproject/0x-monorepo

Shared repository data · GitHub

License detected in repository
Not collected

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 22:31 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:c6f40fb4824bc086d6b8eb3efe7d8d841a2f1398e006162836a6bf8fc9bbb2e2

Other collected versions

3.0.915 Jul3.0.824 Jun3.0.725 Feb3.0.68 Feb3.0.56 Feb3.0.422 JanView all collected versions →