ga4gh / ga4gh/va-spec-python

Expose JSON Schema ID and maturity as class methods

Open
#72 0 comments 0 reactions 1 assignee Claimed by @korikuzma View on GitHub
Dominant language
Python
Stars
2
Forks
1
Avg merge
9d 23h
Merged PRs (30d)
1

Description

### Feature description

In the spec:

```json
{
"$id": "https://w3id.org/ga4gh/schema/va-spec/1.1.0-snapshot.2026-06.1/base/json/Agent",
"maturity": "trial use"
}
```

I imagine others will want this too. It'd be useful to expose this info through class methods, like the following:

```python
CanonicalAllele.schema_id()
# "https://w3id.org/ga4gh/schema/va-spec/1.1.0-snapshot.2026-06.1/base/json/Agent"

Agent.maturity()
# "trial use"
```

It'd also be nice to expose this metadata in `model_json_schema`

### Use case

As I have began working on the starter kit and bundle format for civicpy, I need a way to resolve the schema identifiers.

### Proposed solution

Follow similar approach as https://github.com/ga4gh/cat-vrs-python/pull/48

We'll need to override `schema_id` since VA-Spec is different and W3IDs can be found at base/aac-2017/ccv-2022/amcg-2015

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.