Skip to content

Pin API contract 1.0.0 and check every call against it #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
imronreviady merged 1 commit into from
Oct 3, 2026
Merged

Pin API contract 1.0.0 and check every call against it #7

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions CONTRACT_VERSION
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
1.0.0
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,11 @@ npm install livexface
yarn add livexface
```

Validated against API contract 1.0.0 (`/openapi.json` `info.version`), exported as `CONTRACT_VERSION`.
`npm test` calls every SDK method and checks its HTTP method, path and required fields against the pinned
`contract/openapi-1.0.0.json`; to move to a new contract, copy the release asset `openapi-<version>.json` into
`contract/`, then update the `CONTRACT_VERSION` file and the constant in `src/index.ts`.

## Quick Start

```typescript
Expand Down
Loading
Loading