ome / ome/ngff

0.6rc0 schemas not served from homepage

Open
#563 0 comments 3 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

bug
Dominant language
Python
Stars
171
Forks
75
Avg merge
2d 3h
Merged PRs (30d)
20

Description

I just noticed over at the validator of 0.6 data, that the schemas apparently aren't being served correctly from the ngff domain, which makes the validator fail.

This works: https://ngff.openmicroscopy.org/0.5/schemas/image.schema

this doesn't work: https://ngff.openmicroscopy.org/0.6rc0/schemas/image.schema

... and this does: https://ngff.openmicroscopy.org/dev/schemas/image.schema

As it currently stands, there are generally two ways to get the schemas from the web:

  • Either by pulling them from content that is served from this page, i.e., by following the above links. When 0.6 is released, there should be another submodule on this page which then provides the schemas under https://ngff.openmicroscopy.org/0.6/schemas/something.schema besides the dev branch for the latest schemas.
  • Directly from the release of the ngff-spec repo, i.e., like this: https://raw.githubusercontent.com/ome/ngff-spec/0.6rc0/schemas/image.schema. This doesn't currently work for the older versions, because they are not tagged and released formally from the ngff-spec page.

We could simply create the tags for the past versions, then the second option would also work for all versions.

cc @jni since we talked about this recently.

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

Inspect how the ngff.openmicroscopy.org homepage serves versioned schema paths and how the ngff-spec repository's releases or tags are exposed. Compare the working 0.5 and dev URLs with the failing 0.6rc0 URL, then verify that the intended 0.6 schema path works and that the release strategy covers the required versions.

Written by the indexing model from the issue text.

Assessment

Tech stack
github
Domain
documentation, release
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.