https://github.com/robertmassaioli/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.
https://github.com/robertmassaioli/atlassian-openapi
Last synced: about 2 months ago
JSON representation
This package contains Typescript typings for OpenAPI 3.0 with Atlassian extensions included as well as convenience functions for dealing with OpenAPI 3.0.
- Host: GitHub
- URL: https://github.com/robertmassaioli/atlassian-openapi
- Owner: robertmassaioli
- Created: 2022-01-12T04:11:52.000Z (over 3 years ago)
- Default Branch: master
- Last Pushed: 2024-08-07T23:01:14.000Z (9 months ago)
- Last Synced: 2024-10-14T08:51:08.561Z (7 months ago)
- Language: TypeScript
- Size: 553 KB
- Stars: 1
- Watchers: 2
- Forks: 4
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
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!