opengeospatial / opengeospatial/bblocks-template

Need tool generate a fully resolved schema from building block components

Open
#9 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Shell
Stars
5
Forks
5
PR merge metrics
No merged PRs in 30d

Description

I'm assembling profiles from lots of pieces (see https://github.com/usgin/metadataBuildingBlocks), but the full schema displayed by bblocks-viewer shows all the $refs to building block components that are being assembled, making it difficult to figure out if the resolved schema that assembles all the pieces is doing what you want. A resolved schema is also useful for offline testing and validation instance documents using tools like Oxygen.

PR #8 addresses this issue with python codes to generate resolved schema. Also includes a couple tools to generate JSON schema in parallel to the yaml-encoded json schema and check that the JSON and Yaml are equivalent. I'm a lot more comfortable reviewing and testing the JSON serialized schema.

To make the resolves schema visible in the BBlock view requires update to the bblock viewer code (see https://github.com/ogcincubator/bblocks-viewer/issues/5), and an update to the post processing workflow (Github action) in the Building Block Repository.

Contributor guide

No contributing guide indexed for this repository

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.

Research direction

Review PR #8 first, since it addresses resolved-schema generation and JSON/YAML equivalence checks. Then inspect the bblocks-viewer issue #5 and the Building Block Repository post-processing workflow; done means the resolved schema is visible in the BBlock view and produced by the workflow for offline validation.

Written by the indexing model from the issue text.

Assessment

Tech stack
github-actions, python
Domain
ci-cd, tooling
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.