Skip to content

Commit

Permalink
Bump to v0.8
Browse files Browse the repository at this point in the history
  • Loading branch information
hugoledoux committed Jun 20, 2024
1 parent 932b945 commit 05efde5
Show file tree
Hide file tree
Showing 3 changed files with 11 additions and 6 deletions.
5 changes: 5 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
# Changelog


## [0.8.0] - 2024-06-20
### Modified
- cjseqval removed as a standalone binary, now you can do the same with cjval (stdin is for CityJSONSeq)
- the reporting of the errors for CityJSONSeq is better, and contains a summary

## [0.7.1] - 2024-04-16
### Modified
- fix a bug where Solid with textures having null values were wrongly validated
Expand Down
4 changes: 2 additions & 2 deletions Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[package]
name = "cjval"
version = "0.8.0-b0"
description = "Schema-validation of CityJSON + CityJSONSeq files"
version = "0.8.0"
description = "Schema-validation of CityJSON + CityJSONSeq datasets"
authors = ["Hugo Ledoux <h.ledoux@tudelft.nl>"]
edition = "2021"
license = "MIT"
Expand Down
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# cjval: schema-validation of CityJSON + CityJSONSeq files
# cjval: schema-validation of CityJSON + CityJSONSeq datasets

[![crates.io](https://img.shields.io/crates/v/cjval.svg)](https://crates.io/crates/cjval)
[![GitHub license](https://img.shields.io/github/license/cityjson/cjval)](https://github.com/cityjson/cjval/blob/main/LICENSE)

A library to validate the syntax of CityJSON objects (CityJSON + [CityJSONSeq](https://www.cityjson.org/cityjsonseq)).
A Rust library and binaries to validate the syntax of CityJSON objects (CityJSON + [CityJSONSeq](https://www.cityjson.org/cityjsonseq)).

It validates against the [CityJSON schemas](https://www.cityjson.org/schemas) and additional functions have been implemented (because these checks cannot be expressed with [JSON Schemas](https://json-schema.org/)).

Expand All @@ -18,14 +18,14 @@ The following error checks are performed:
1. *textures*: checks if the arrays for the textures are coherent (if the vertices exist + if the texture exists)
1. *materials*: checks if the arrays for the materials are coherent with the geometry objects and if the material exists

It also verifies the following, these are not errors since the file is still considered valid and usable, but they can make the file larger and some parsers might not understand all the properties:
It also verifies the following, these are not errors but warnings since the file is still considered valid and usable, but they can make the file larger and some parsers might not understand all the properties:

1. *extra_root_properties*: if CityJSON has extra root properties, these should be documented in an Extension. If not this warning is returned
1. *duplicate_vertices*: duplicated vertices in `"vertices"` are allowed, but they take up spaces and decreases the topological relationships explicitly in the file. If there are any, [cjio](https://github.com/cityjson/cjio) has the operator `clean` to fix this automatically.
1. *unused_vertices*: vertices that are not referenced in the file, they take extra space. If there are any, [cjio](https://github.com/cityjson/cjio) has the operator `clean` to fix this automatically.


## Library + 2 binaries
## A Rust library + 2 binaries

`cjval` is a library, and has 2 different binaries:

Expand Down

0 comments on commit 05efde5

Please sign in to comment.