# @atlassian/atlassian-openapi

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

Latest version **1.0.6** (published 2025-06-25) · MIT license · 0 weekly downloads

## Install

```sh
npm install @atlassian/atlassian-openapi
pnpm add @atlassian/atlassian-openapi
yarn add @atlassian/atlassian-openapi
bun add @atlassian/atlassian-openapi
```

## Health

**Score 35/100 (D)** — status: maintenance-mode.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: stale; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.6 |
| Published | 2025-06-25 |
| First published | 2025-05-21 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 2 |
| Unpacked size | 59.8 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 1 |
| Author | Robert Massaioli |
| Maintainers | atlassianartifactteam |
| Keywords | atlassian, openapi, swagger |

## Links

- npm: https://www.npmjs.com/package/@atlassian/atlassian-openapi
- Repository: https://github.com/atlassian-forks/atlassian-openapi
- Homepage: https://github.com/atlassian-forks/atlassian-openapi#readme
- Issues: https://github.com/atlassian-forks/atlassian-openapi/issues
- npm.io page: https://npm.io/package/@atlassian/atlassian-openapi

## Dependencies (2)

- [urijs](https://npm.io/package/urijs.md) ^1.19.10
- [jsonpointer](https://npm.io/package/jsonpointer.md) ^5.0.0

## Recent versions

- 1.0.6 (latest) — 2025-06-25
- 1.0.5 — 2025-06-25
- 1.0.4 — 2025-06-25
- 1.0.3 — 2025-05-21

## 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 `$ref`s 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!

---
_Source: https://npm.io/package/@atlassian/atlassian-openapi · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._