https://github.com/podium/json_schema_nif
https://github.com/podium/json_schema_nif
Last synced: 6 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/podium/json_schema_nif
- Owner: podium
- License: mit
- Created: 2024-04-30T23:16:22.000Z (about 1 year ago)
- Default Branch: master
- Last Pushed: 2024-11-04T18:31:33.000Z (7 months ago)
- Last Synced: 2024-11-04T19:35:05.676Z (7 months ago)
- Language: Elixir
- Size: 79.1 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# JsonSchemaNif
Library for validating JSON instances against JSON schemas.
Provides a straightforward way to ensure that JSON data adheres to a predefined schema, enhancing the reliability and
consistency of data. Especially useful in contexts like Kafka.
## Installation
The package can be installed by adding `json_schema_nif` to your list of dependencies in `mix.exs`:
```elixir
defp deps do
[
{:json_schema_nif, "~> 0.1.0"}
]
end
```
## Contributing
See [CONTRIBUTING.md](./CONTRIBUTING.md).
## Documentation
Documentation is available in [HexDocs](https://hexdocs.pm/json_schema_nif/readme.html).
## Releasing
Since we rely on RustlerPrecompiled actually building our Rust bindings in advance,
we need to follow their [recommended flow](https://hexdocs.pm/rustler_precompiled/precompilation_guide.html#recommended-flow):
1. Release a new tag
1. Push the code to your repository with the new tag: git push origin main --tags
1. Wait for all NIFs to be built
1. Run the `mix rustler_precompiled.download JsonSchemaNif --all`task (with the flag --all)
release the package to Hex.pm (make sure your release includes the correct files).
- Run `mix hex.build --unpack` to ensure checksum files exist