https://github.com/tillhub/schemas
All Tillhub API OpenAPI 3 compatible JSON Schemas.
https://github.com/tillhub/schemas
json-schema
Last synced: 5 months ago
JSON representation
All Tillhub API OpenAPI 3 compatible JSON Schemas.
- Host: GitHub
- URL: https://github.com/tillhub/schemas
- Owner: tillhub
- License: apache-2.0
- Created: 2018-07-23T19:11:12.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2026-01-15T16:33:01.000Z (5 months ago)
- Last Synced: 2026-01-15T19:42:13.434Z (5 months ago)
- Topics: json-schema
- Language: JavaScript
- Size: 19.8 MB
- Stars: 6
- Watchers: 14
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Tillhub API Schemas [](https://circleci.com/gh/tillhub/schemas/tree/master) [](https://github.com/semantic-release/semantic-release)
> All Tillhub API OpenAPI 3 compatible JSON Schemas.
## Getting Started
```bash
npm install @tillhub/schemas
```
Use this library to pre-validate request objects. This will always be up-to-date and versioned, since the Tillhub API uses this library as well.
```js
const createCartSchema = require('@tillhub/schemas').v1.carts.create.request
console.log(createCartSchema)
// prints a JS object of the full schema
// {
// type: 'object',
// additionalProperties: true,
// properties: {
// ...
// }
// }
```
## Release flow
Releases are automated with @semantic-release.
For triggering a new release just use commit messages started from "feat" or "fix" prefix which
is part of [proper message format](https://github.com/semantic-release/semantic-release#commit-message-format) (please do not forget about it!).
CricleCI takes care of publishing the package. it will only trigger on the master branch.
After the PR is merged into master, CircleCI will start the deployment process:
1. It will checkout the project and installs the dependencies.
2. Linter will check the code.
3. It will run the tests to make sure everything runs perfectly.
4. Code will be compiled.
4. Finally, it will publish the new version by running `semantic-release`.
## Contributing
Contributions are welcome in the case of falsy information. Those schemas are used as internaly driven data logic and quality.
Contributors should commit only via the following command. Deployment and change tracking is automatised by the underlying semantic-release implementation.
```bash
npm run commit
```
### Resources CRUD CLI
Use the schema cli to create new resources automatically using Hygen:
```console
$ npm run new:schema
> # interactive CLI
```
It will create the resources for the new schema and the route for it.
Feel free to edit any files you need and don't forget to add the custom properties (if necessary) on:
`/lib//base.js`
## License
Apache-2.0