Skip to content

Re-design verifier to work on pulled local copies #13

@mbaudis

Description

@mbaudis

As discussed in #12 (and in previous issues for the Beacon v2 sources, using relative links to individual Github schemas inside a given project may lead to inconsistent behaviour when resolving schemas, while using absolute URLs to GH raw files brings another level of maintenance headaches, binds the schema to the hosting service and makes schema extensions extremely complicated; but especially breaks use cases with limited or missing network I/O. Some note:

Having external URLs within schema makes it impossible to use within other programs directly. This is mainly due to security and we would typically block outbound connections from containers/clusters.
I like the idea of strictly local verification with zero HTTP calls to GitHub.
Originally posted by @anuradhawick in #12 (comment)

Proposal

  • re-design the verifier to (pull and) access local schema trees
  • review & revise $ref parameters in https://github.com/ga4gh-beacon/beacon-v2/ - which may include a rethinking of external schema $ref values (so far only VRS)
  • documentation about use...

Alternatively or as addition, we could provide fully de-referenced schemas for all entities.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions