NatLabRockies / NatLabRockies/OpenStudio

Add `json_schemer` gem

Open
#4,969 11 comments 0 reactions 1 assignee View on GitHub

@wenyikuang is already working on this.

Since Oct 17, 2024.

Enhancement Request
Dominant language
C++
Stars
646
Forks
237
Avg merge
3d 11h
Merged PRs (30d)
10

Description

Enhancement Request

OpenStudio includes the json-schema gem, but it is barely maintained and many users recommend switching to json_schemer gem. Not only is the json_schemer gem well maintained, but it supports newer drafts of the JSON schema that are heavily utilized these days. The json-schema gem has no current progress towards supporting newer drafts of the schema.

For DOE's Home Energy Score project, we are unable to use the current json-schema gem because it doesn't support JSON Schema draft-07. This means that we can't validate JSON files submitted and has occasionally led to issues.

(Perhaps OpenStudio should consider replacing the json-schema gem, but that would be a breaking change.)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.