npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2026 – Pkg Stats / Ryan Hefner

@nemtus/symbol-openapi

v1.0.5

Published

OpenAPI Specification of catapult-rest

Vulnerabilities

Powered byPowered by Snyk
  • 0High
  • 0Medium
  • 0Low

Links

Git

Maintainers

yasunori-matsuokayasunori-matsuokaymuichiroymuichiro

Keywords

Readme

Note (nemtus mirror): This package (@nemtus/symbol-openapi) is a content mirror of the OpenAPI specification from symbol/symbol (openapi/). The only change from upstream is the npm package name; the specification content is unmodified. Licensed under Apache-2.0. For the canonical project, see symbol/symbol.

symbol-openapi

OpenAPI specification for catapult-rest.

This project lives in the Symbol monorepo under openapi/.

Requirements

  • Node.js 20 LTS or higher

YAML style and syntax for files under spec/ are checked by the monorepo Linters job (linters/scripts/lint_yaml.sh -> yamllint with linters/yaml/.yamllint). Run that from the repository root if you need the same check locally:

./linters/scripts/lint_yaml.sh

Installation

  1. Clone the monorepo and enter this package.
git clone https://github.com/symbol/symbol.git
cd symbol/openapi
  1. Install dependencies.
npm install

Commands

Build

Compile the specification. The generated output is saved under the _build directory.

npm run build

Test

Checks links in the built specification (_build/openapi3.yml).

npm run test

In CI the flow is split into dedicated stages:

  • scripts/ci/lint.sh -> npm run lint (OpenAPI lint on spec/openapi.yml)
  • scripts/ci/build.sh -> npm run build (bundle to _build/openapi3.yml)
  • scripts/ci/test.sh -> npm run test

Postman

Generate a Postman collection from the built specification.

npm run postman

Release (monorepo)

Release in monorepo is component-scoped (openapi/) and produces versioned OpenAPI + Postman artifacts.

  1. Bump version in package.json and update CHANGELOG.md.
  2. Run publish script:
scripts/ci/publish.sh

This prepares:

  • _build/openapi3.yml
  • _build/openapi3.json
  • _build/postman.json
  • _build/v<version>/openapi3.yml
  • _build/v<version>/openapi3.json
  • _build/v<version>/postman.json

Optional: create a GitHub release with assets (requires authenticated gh CLI):

OPENAPI_RELEASE_CREATE_GH=1 OPENAPI_RELEASE_TAG=openapi/v<version> scripts/ci/publish.sh

Contributing

Before contributing please read this.

License

Licensed under the Apache License 2.0.