https://github.com/ga4gh-beacon/beacon-v2

Unified repository for the GA4GH Beacon v2 API standard
https://github.com/ga4gh-beacon/beacon-v2

json-schema schema

Last synced: 11 days ago
JSON representation

Unified repository for the GA4GH Beacon v2 API standard

• Host: GitHub
• URL: https://github.com/ga4gh-beacon/beacon-v2
• Owner: ga4gh-beacon
• License: cc0-1.0
• Created: 2022-02-22T08:53:58.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-12T16:24:44.000Z (14 days ago)
• Last Synced: 2024-12-12T16:27:56.826Z (14 days ago)
• Topics: json-schema, schema
• Homepage:
• Size: 5.4 MB
• Stars: 27
• Watchers: 11
• Forks: 22
• Open Issues: 57
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Security: docs/security.md

Awesome Lists containing this project

README

        
# Unified repository for Beacon v2 Code & Documentation

## Description

This repository is a unified repository representing the different parts of the Beacon API:

* [framework](framework)

* [models](models)

* Beacon v2 Documentation

    - authoritive source already in this repository [`/docs`](docs)

    - rendered version through [here](https://beacon-project.io/beacon-v2/) (alternative address is [docs.genomebeacons.org](https://docs.genomebeacons.org))

As with other schema projects, here we separate between the schema source files (in `src`; JSON-Schema written in YAML) and the generated versions for referencing. The current setup allows already the direct referencing of the generated JSON schemas. Examples:

* `ontologyTerm`:

    - YAML (source): 

        * edit: 

        * raw: 

    - JSON: 

* `biosamples/defaultSchema`

    - YAML (source): 

        * edit: 

        * raw: 

    - JSON: 

* `beaconRequestBody`:

    - YAML (source): 

    - JSON: 

There is a set of tools in [`/bin`](./bin/) to facilitate the conversion. ATM, after editing `...yaml` schema files somewhere in the `/src` tree, a (local) run of `bin/yamlerRunner.sh` - which re-generates the `....json` files in the `/json` tree) has to be performed before pushing changes.

### Changelog

## 2.1.1

*Released, October, 8, 2024*

[Beacon-v2.1.1](https://github.com/ga4gh-beacon/beacon-v2/tree/5ea17fbd0d2ba533aa1e85f7271f9a2cc9be6794)

* Changed uri for uri-template in Endpoint.singleEntryUrl

## 2.1.0

*Released, July, 19, 2024*

[Beacon-v2.1.0](https://github.com/ga4gh-beacon/beacon-v2/tree/16862205c79294fae5473f7fa330bf5929b3b120)

* Relocated TypedQuantity required to proper level of the schema for complexValue

* Added end and start entities for ageRange and iso8601duration for age

* Filtering terms scopes changed from string to array of strings

## 2.0.1

*Released July, 16, 2024*

[Beacon-v2.0.1](https://github.com/ga4gh-beacon/beacon-v2/tree/f6f85c445922831bd398552384593206c86287de)

* Replaced ENSGLOSSARY for SO ontology family in documentation examples

* Moved CURIE to beaconCommonComponents

* Created filtering terms entity

* Removed validation directories

* Several fixes to entity types, typos and other non-breaking changes

## 2.0.0

*Released June, 21, 2022*

[Beacon-v2.0.0](https://github.com/ga4gh-beacon/beacon-v2/tree/d07ef1626321f7428374a4f68d864dfa5e98370f)

* change notes with respect to the repository & documentation are now in [docs.genomebeacons.org](https://docs.genomebeacons.org/changes-todo/)

* NOTE: on 2022-06-20 the previous development repositories have been archived:

    - ARCHIVE - [beacon-framework-v2](https://github.com/ga4gh-beacon/beacon-framework-v2)

    - ARCHIVE - [beacon-v2-Models](https://github.com/ga4gh-beacon/beacon-v2-Models)

## Directory structure

```

|-docs          Contain the source (Markdown) for the mkdocs generated documentation

|

|- framework

|   |

|   |- src      schema source in YAML format; for editing

|   |

|   |- json     JSON versions of the schema files generated from src, authorative/referenceable version

|

|- models

|   |

|   |- src      schema source in YAML format; for editing

|   |

|   |- json     JSON versions of the schema files generated from src, authorative/referenceable version

|

|- bin          scripts and configurations for creating the unified structure

    |

    |- yamlerRunner.sh    runs the conversions for the different repos and format options

    |

    |- beaconYamler.py    conversion app

    |

    |- config.yaml        text replacements and options

```