https://github.com/braze-community/braze-specification

📖 Postman collection and OpenAPI spec for Braze API.
https://github.com/braze-community/braze-specification

braze braze-api braze-documentation json npm openapi postman-collection spec specification

Last synced: 20 days ago
JSON representation

📖 Postman collection and OpenAPI spec for Braze API.

• Host: GitHub
• URL: https://github.com/braze-community/braze-specification
• Owner: braze-community
• License: mit
• Created: 2023-08-09T00:45:18.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2024-04-11T03:12:11.000Z (7 months ago)
• Last Synced: 2024-04-11T05:22:20.130Z (7 months ago)
• Topics: braze, braze-api, braze-documentation, json, npm, openapi, postman-collection, spec, specification
• Language: TypeScript
• Homepage: https://npmjs.com/package/braze-specification
• Size: 1.72 MB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# braze-specification

[![NPM](https://nodei.co/npm/braze-specification.png)](https://nodei.co/npm/braze-specification/)

[![NPM version](https://img.shields.io/npm/v/braze-specification.svg)](https://www.npmjs.com/package/braze-specification)

[![build](https://github.com/braze-community/braze-specification/actions/workflows/build.yml/badge.svg)](https://github.com/braze-community/braze-specification/actions/workflows/build.yml)

[![lint](https://github.com/braze-community/braze-specification/actions/workflows/lint.yml/badge.svg)](https://github.com/braze-community/braze-specification/actions/workflows/lint.yml)

Braze API specification:

- [OpenAPI spec](https://github.com/braze-community/braze-specification/blob/master/openapi/spec.json)

- [Postman collection](https://github.com/braze-community/braze-specification/blob/master/postman/collection.json)

See the original [Postman collection](https://documenter.getpostman.com/view/4689407/SVYrsdsG).

## Installation

[NPM](https://www.npmjs.com/package/braze-specification):

```sh

npm install braze-specification

```

[Yarn](https://yarnpkg.com/package/braze-specification):

```sh

yarn add braze-specification

```

## Usage

Require OpenAPI spec and Postman collection with CommonJS:

```ts

const spec = require('braze-specification/openapi/spec.json');

const collection = require('braze-specification/postman/collection.json');

```

Or import OpenAPI spec and Postman collection with ES Modules:

```ts

import spec from 'braze-specification/openapi/spec.json';

import collection from 'braze-specification/postman/collection.json';

```

## License

[MIT](https://github.com/braze-community/braze-specification/blob/master/LICENSE)