@canopyinc/api-docs NPM

Canopy OpenAPI Schema

Library

This specification serves as the one and only source of truth throughout Canopy's stack.

We use the v3.0.3 version of the OpenAPI spec.

Initial setup

Ensure you're on Node 14 or later: nvm install lts
yarn
The pre-commit hook will bundle, validate, generate TS and Go types, and format the code before pushing. You can run either of those individually by referring to scripts in package.json.
Optional: install Crunch42 extension for VSCode.

Live documentation structure

The openapi.json file is the entrypoint to the modular spec that we use for development.

Paths defined within the OpenAPI specification all contain local references to the requestBodies, responses, and schemas sections. However, these sections themselves all contain remote references, so that each request body, response, and schema definition is contained within its own file in its respective directory within this documentation.

We consolidate these modules and dereference them into one unified json file that is used for validation and deployment.

Updating the live documentation

Changes made to the master branch are deployed via GitHub Actions to internal docs here.

When committing `master`, a pre-commit hook will build and validate the `dist/consolidated.json` file to ensure a valid API specification can be generated. In order for this commit to be successful, ensure that you are running Node 14 or later.

Changes made to the production branch will be deployed via GitHub Actions to the live documentation site.

Validation

The CI workflow validates the consolidated OpenAPI file before deploying it. Please validate your changes in one of two ways before pushing:

yarn validate
Open up the Crunch42 extension for VSCode with dist/consolidated.json in the editor and run a security audit by either clicking on the purple icon in the top right corner of the editor or opening up the launcher via Cmd-Option-P and entering "security". First option should be OpenAPI: perform security audit.
See docs for more info.

Publish

To publish to NPM, bump package version accordingly with npm version [patch|minor|major]. See NPM CLI docs.
Run npm publish to publish your new version.

MAJOR version when you make incompatible API changes
MINOR version when you add functionality in a backwards compatible manner
PATCH version when you make backwards compatible bug fixes

Type Generation

To include a schema for type generation, include it as a part of openapi.json["schemas"].
Run yarn build.

@everything-registry/sub-chunk-154 @infinitebrahmanuniverse/nolb-_can @zalastax/nolb-_can

1 day ago

1 day ago

1 day ago

2 days ago

2 days ago

6 days ago

6 days ago

8 days ago

8 days ago

9 days ago

14 days ago

15 days ago

16 days ago

16 days ago

17 days ago

22 days ago

22 days ago

23 days ago

27 days ago

29 days ago

1 month ago

1 month ago

1 month ago

1 month ago

2 months ago

2 months ago

2 months ago

3 months ago

3 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

4 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

5 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

7 months ago

7 months ago

6 months ago

6 months ago

6 months ago

6 months ago

6 months ago

7 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

9 months ago

9 months ago

9 months ago

9 months ago

9 months ago

7 months ago

7 months ago

9 months ago

9 months ago

8 months ago

6 months ago

6 months ago

7 months ago

7 months ago

7 months ago

7 months ago

7 months ago

10 months ago

6 months ago

9 months ago

11 months ago

11 months ago

9 months ago

7 months ago

7 months ago

7 months ago

7 months ago

9 months ago

11 months ago

12 months ago

11 months ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1 year ago

1 year ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-experiment-c4eeee

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

0.0.0-experiment-20220216

2 years ago

1.7.17

2 years ago

1.8.10-authorize-net-api-change

2 years ago

1.7.19

2 years ago

1.7.20

2 years ago

1.8.1-0.1-authorize-net-api-change

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

1.7.20-daily-interest

2 years ago

0.0.0-experiment-202202171311

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

1.7.9-new-min-pay-type

3 years ago

1.7.1-2-feature-refunds

3 years ago

2 years ago

2 years ago

2 years ago

2 years ago

2 years ago

3 years ago

1.7.1-1-checkout-source-id

3 years ago

1.8.1-bhg

3 years ago

1.7.9-entity-client-ids

3 years ago

1.7.1-checkout-source-id

3 years ago

1.7.8-entity-client-ids

3 years ago

1.7.7-entity-client-ids

3 years ago

1.7.5-entity-client-ids

3 years ago

1.7.6-entity-client-ids

3 years ago

1.7.2-entity-client-ids

3 years ago

1.7.1-0

3 years ago

1.7.3-entity-client-ids

3 years ago

1.7.0

3 years ago

1.7.4-entity-client-ids

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

1.2.7-metro2-report.2

3 years ago

1.2.7-metro2-report.1

3 years ago

1.2.7-metro2-report.0

3 years ago

1.2.7-account-delete-200-message.1

3 years ago

1.2.7-account-delete-200-message.0

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

3 years ago

1.2.6-account-discount-config-response-fix.0

3 years ago

1.3.0-0

3 years ago

1.2.3-soft-delete-account.0

3 years ago

1.2.6-metro2.0

3 years ago

1.2.5-lithic-card-program-token-0

3 years ago

1.2.5-card-spend-limit.0

3 years ago

1.2.6-pp-config-update-fix

3 years ago

1.2.0

3 years ago

1.2.1

3 years ago

1.1.2-fee-waiver-dev.0

3 years ago

1.1.2-vikram

3 years ago

1.1.2-0

3 years ago

1.1.1

3 years ago