PkgFoundry
Catalog npm
Back to packageRELEASE DETAILS

1.0.1

npm

@0xproject/sra-spec

Standard Relayer API Open API Spec

Published5 Sept 2018
Direct dependencies19
Transitive dependenciesNot calculated

README

Current package documentation

@0xproject/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 '@0xproject/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=@0xproject/sra-spec yarn build

Or continuously rebuild on change:

PKG=@0xproject/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
@0xproject/json-schemas
Environment
{
  "local_name": "@0xproject/json-schemas",
  "alias": false,
  "peer_metadata": null
}
^1.0.1runtime
@0xproject/tslint-config
Environment
{
  "local_name": "@0xproject/tslint-config",
  "alias": false,
  "peer_metadata": null
}
^1.0.7development
@loopback/openapi-v3-types
Environment
{
  "local_name": "@loopback/openapi-v3-types",
  "alias": false,
  "peer_metadata": null
}
^0.8.2development
@types/mocha
Environment
{
  "local_name": "@types/mocha",
  "alias": false,
  "peer_metadata": null
}
^2.2.42development
@types/node
Environment
{
  "local_name": "@types/node",
  "alias": false,
  "peer_metadata": null
}
^10.5.3development
chai
Environment
{
  "local_name": "chai",
  "alias": false,
  "peer_metadata": null
}
^4.0.1development
chokidar-cli
Environment
{
  "local_name": "chokidar-cli",
  "alias": false,
  "peer_metadata": null
}
^1.2.0development
copyfiles
Environment
{
  "local_name": "copyfiles",
  "alias": false,
  "peer_metadata": null
}
^2.0.0development
dirty-chai
Environment
{
  "local_name": "dirty-chai",
  "alias": false,
  "peer_metadata": null
}
^2.0.1development
discharge
Environment
{
  "local_name": "discharge",
  "alias": false,
  "peer_metadata": null
}
^0.7.1development
mocha
Environment
{
  "local_name": "mocha",
  "alias": false,
  "peer_metadata": null
}
^4.0.1development
npm-run-all
Environment
{
  "local_name": "npm-run-all",
  "alias": false,
  "peer_metadata": null
}
^4.1.3development
nyc
Environment
{
  "local_name": "nyc",
  "alias": false,
  "peer_metadata": null
}
^11.0.1development
redoc-cli
Environment
{
  "local_name": "redoc-cli",
  "alias": false,
  "peer_metadata": null
}
^0.6.1development
shx
Environment
{
  "local_name": "shx",
  "alias": false,
  "peer_metadata": null
}
^0.2.2development
swagger-cli
Environment
{
  "local_name": "swagger-cli",
  "alias": false,
  "peer_metadata": null
}
^2.1.1development
ts-node
Environment
{
  "local_name": "ts-node",
  "alias": false,
  "peer_metadata": null
}
^7.0.0development
tslint
Environment
{
  "local_name": "tslint",
  "alias": false,
  "peer_metadata": null
}
5.11.0development
typescript
Environment
{
  "local_name": "typescript",
  "alias": false,
  "peer_metadata": null
}
3.0.1development

Distribution files

1 collected
Distribution 1

Source distribution

Source file
Checksums from source
{
  "shasum": "4139ab9e36a50ec5a83ff65669274c88d3874c23",
  "tarball": "https://registry.npmjs.org/@0xproject/sra-spec/-/sra-spec-1.0.1.tgz",
  "integrity": "sha512-aTtYSZv8cKPpmqsGOaXaylJUHG6rwQw16KsATZ9lFShy/2GF7NxVVtgACrUZ5RqHJ3twBTvZDF+Gpjz/1Rtc+Q==",
  "fileCount": 91,
  "unpackedSize": 119643,
  "npm-signature": "-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJbj60qCRA9TVsSAnZWagAAQnUQAKQIxXNPKriEw608UID5\n0ZheAI938UZUWWGhfPGuiPvb6/ZZ8Afnj0q/rKl48yqtDT2AXgcJuQTOZiMr\nla+hQBDtQu6fplQB9Iy3SYVe51Rzdx0hNOr0MzGWjEFIFTBMd2SwXX8CU3sf\n3vAMbjq+EWG6f1Het4cYLWUcZs6vHhlu+f+LMdNSxMDTXZpXous2z1T78C0M\nqjoZ5HFi+PtdKzflt8Qq1iqDn8teKei7u4cyq2Z0XtP3KBricg1BsSn3CrCu\nHBbz9ZLaSR+9KH/82+SoojPakrTqrFWLl/iqmQ5xSk9/cnNaJvgCRCwANqEM\nE2sWGXCeibdilBfcfaygehOEHkayJfjLAgGNyNv2ucSeXH2iMXCWWWGTPBpc\ncuzQ1dpF43sq8z/YLXuyS9lm3K+nErxRJPqzN5Qkko3kQGmqIeRgl/DGFnLB\nGaKC0brk+dOsOhiIwg9if+8WqEjI+E2kzigWIZgGYUYuAOBPvuzZV9DaKHrl\nMu6PGZKIH3nmD8cvVmhTz439tk8e7vqkNYX/pgaAufJ/bT1KRJY/gyeEPmAI\nfBHtQRYMxC2K0dz9Yj/nz5Dhz4Akku6wyCWksHTNrE0NI5Q9N6QyPFSKPP7h\n0PeKJlPByMKZL62nhqwq3KhsRjZ1cOYM5ZRQq3zjfe2XfA2NI6L6tUTwNXOw\n4PWV\r\n=2lZ0\r\n-----END PGP SIGNATURE-----\r\n",
  "signatures": [
    {
      "keyid": "SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA",
      "sig": "MEUCIQDsTHEh+YtiFEv8xj4+BMwIOPnsvJHNPMV1I6KOjxt0WQIgQSQ1iJDgRG4V2ZXtjIrx5b99aoM8gYWWzGKsd+Dhb/4="
    }
  ]
}

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 21 Oct, 09:34 UTC

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

Record identity

package_version:e27182edf0deefb70dc2291431dbf757fb165252ab336589eca20a861c8aad4c

Other collected versions

1.0.64 Oct1.0.528 Sept1.0.425 Sept1.0.325 Sept1.0.221 Sept1.0.1-rc.627 AugView all collected versions →