Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Establish convention for GA4GH Schema persistent URLs #50

Open
ahwagner opened this issue Mar 26, 2024 · 0 comments · Fixed by perma-id/w3id.org#4304
Open

Establish convention for GA4GH Schema persistent URLs #50

ahwagner opened this issue Mar 26, 2024 · 0 comments · Fixed by perma-id/w3id.org#4304
Assignees
Labels
CRITICAL Decision needs to be made soon

Comments

@ahwagner
Copy link
Member

Problem Statement

The GKS Work Stream is trying to align conventions for resolving persistent URLs (pURLs) for schemas maintained by GA4GH.

Impact of alignment between standards

Consistency in the structure of pURLs drives consistency and cohesion across products, and makes it easier to document and describe GA4GH schema resources at a high level.

Background research and landscape analysis

GA4GH already uses w3id.org as a persistent URL resolver for GA4GH products, including VRS 1.3 definitions. The need for persistent URLs is important for use of online JSON Schema documents that should be resolvable by an $id attribute.

Proposed solution

We would like to establish a convention for registering GA4GH schema resolution at w3id.org, and propose the following syntax:

GKS URL Syntax

In this proposal, the product specific section may be variable from product to product, but otherwise all components are consistent across specifications.

This solution requires:

  1. TASC to register GKS schemas under the /ga4gh/schema/ path
  2. TASC to review requests for other GA4GH schema registrations at w3id.org and enforce consistent pURL patterns under the /ga4gh/schema/ path
@mamanambiya mamanambiya added the CRITICAL Decision needs to be made soon label May 22, 2024
ahwagner added a commit to ga4gh/w3id.org that referenced this issue Jul 25, 2024
ahwagner added a commit to ga4gh/w3id.org that referenced this issue Jul 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CRITICAL Decision needs to be made soon
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants