Skip to content

Commit

Permalink
Add 2 notes with suggested conventions for the file extensions
Browse files Browse the repository at this point in the history
  • Loading branch information
hugoledoux committed Nov 8, 2022
1 parent 9dfc283 commit 9760902
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion specs/specs.bs
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,11 @@ A CityJSON object:
- **may** have one member with the name `"geometry-templates"`, the value is a JSON object containing the templates that can be reused by different City Objects (usually for trees). This is equivalent to the concept of "implicit geometries" in CityGML. See [[#geometry-templates]] for details.
- **may** have other members, and their value is not prescribed. Because these are not standard in CityJSON, they might be ignored by parsers.


<div class="note">
**Suggested convention:** A file containing one CityJSON object may have the extension `'.city.json'`
</div>

The minimal valid CityJSON object is thus:

```json
Expand Down Expand Up @@ -1491,10 +1496,15 @@ Below is an example of a CityJSONFeature stream (or a JSON Lines text file), wit
{"type":"CityJSONFeature","id":"b","CityObjects":{...},"vertices":[...]}
{"type":"CityJSONFeature","id":"c","CityObjects":{...},"vertices":[...]}
```

<div class="note">
**Suggested convention:** `"CityJSON"` and `"CityJSONFeature"` objects may be stored in a file with the extension `'.city.jsonl'`
</div>
<div class="note">
CityJSON does not prescribe the format or standard that should be used to store several JSON objects in a given file, it only defines how `"CityJSON"` and `"CityJSONFeature"` objects should be defined.
Observe that CityJSON does not prescribe the format or standard that should be used to store several JSON objects in a given file, it only defines how `"CityJSON"` and `"CityJSONFeature"` objects should be defined.
</div>


# Extensions

CityJSON uses [JSON Schemas](http://json-schema.org/) to document and validate its data model, including its Extensions. Schemas offer a way to validate the syntax of a JSON document.
Expand Down

0 comments on commit 9760902

Please sign in to comment.