microsoft / microsoft/AzureTRE

Pipeline Template JSON Schema versions

Open
#4,795 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

api documentation question
Dominant language
Python
Stars
235
Forks
192
Avg merge
1d 23h
Merged PRs (30d)
13

Description

Description

I was just looking in to the differences within the JSON Schema and I could not see anywhere in the TRE Docs what schema are supported. We seem to be using Draft 07 in the templates are
"$schema": "http://json-schema.org/draft-07/schema",
yet there are properties in the template that are newer such as unevaluatedProperties
api_app/models/domain/resource_template.py

I think there needs to be documented standards around this and the templates may need updating to suit

Contributor guide

Open the contributing guide

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

Start by reviewing api_app/models/domain/resource_template.py and the linked JSON Schema specification, then compare the templates' declared Draft 07 schema with their use of unevaluatedProperties. Done means the supported schema standard is documented in TRE Docs and the templates are updated if the chosen standard requires it.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.