Documentation updates #364
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #364 +/- ##
=======================================
Coverage 98.79% 98.79%
=======================================
Files 15 15
Lines 1245 1247 +2
=======================================
+ Hits 1230 1232 +2
Misses 15 15 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
| @@ -601,10 +601,13 @@ def metadata_template(loc: str | Path | None = None) -> None: | |||
|
|
|||
| template = {} | |||
| for name, descr in EXP_JSONSCHEMA["properties"].items(): | |||
| if name in EXP_JSONSCHEMA["required"]: | |||
| description = f"<REQUIRED {descr['description']}>" | |||
| if "const" in descr.keys(): | |||
There was a problem hiding this comment.
I'm not 100% sure I follow what this addition is doing?
There was a problem hiding this comment.
If the schema defines the name should be a const, it dumps that straight into the output YAML, instead of the description.
So, before, if you ran metadata-template, the first line would be:
schema: <The version of the schema (string)>If the user leaves that in and doesn't update it to match the current schema version, metadata-validate will fail.
With this change, the first line of metadata-template output will be:
schema: 1-0-3
Closes #353 and closes #362 .
This PR adds documentation updates to:
access-nri-intake-catalogwithout Gadi access;metadata.yamlfile;A small code edit was also added - the
metadata-templateutility function will now automatically add the correctschema_versionconstant to the templatemetadata.yamloutput.