Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

atlassian-openapi

robertmassaioli1.1mMIT1.0.21TypeScript support: included

This is a package that lets you deal with the Atlassian flavour of the OpenAPI 3.0 specification.

atlassian, openapi, swagger

readme

atlassian-openapi

This package contains Typescript typings for OpenAPI 3.0 with Atlassian extensions included as well as convenience functions for dealing with OpenAPI 3.0.

Atlassian code and tooling that is based on OpenAPI 3.0 should use this library.

Specifically, it includes:

  • A Swagger namespace with OpenAPI 3.0 types.
  • A Lookup class to let you easily resolve $refs within your OpenAPI files.
  • OpenAPI Operation Grouping logic that mirrors developer.atlassian.com's Side Nav and Postman collections.
  • Type Checking functions to let you differentiate between different types.

Enjoy!