ENH: Produce inplace volumes result schema #957
Conversation
| class InplaceVolumesGenerateJsonSchema(GenerateJsonSchema): | ||
| """Implements a schema generator so that some additional fields may be added.""" |
There was a problem hiding this comment.
In a follow-up PR I think I want to see if I can apply a generator schema generator from SchemaBase to use as a default
4b0d4b3 to
5df7391
Compare
| @@ -24,7 +24,7 @@ jobs: | |||
| - name: Check schema | |||
| run: | | |||
| ./tools/update_schema | |||
| ./tools/update-schema | |||
There was a problem hiding this comment.
POSIX convention is usually hyphens for executable names
There was a problem hiding this comment.
OK, when I read about (asking chatgpt), it says that "Underscores are more common in internal or development scripts where they are not directly exposed to users (e.g., build_script)." Hyphen is OK with me
There was a problem hiding this comment.
I think this is a case where ChatGPT is happy to oblige. I get:
For scripts that are invoked as executables, hyphens (-) are generally more common than underscores (
_) between words. This convention aligns with the broader Unix/Linux philosophy and naming practices, where hyphen-separated names are easier to type and visually distinct. For executable scripts, prefer hyphens (-) unless there's a compelling reason to use underscores (_).
| SCHEMAS = [ | ||
| FmuResultsSchema, | ||
| InplaceVolumesSchema, | ||
| ] |
There was a problem hiding this comment.
Here and in the tests we are collecting a list of all (two) the schemas to iterate over them. There should probably be a place in the code to collect them, but I think waiting for the next one to see where that should be might land it in a better spot (maybe?)
| parser.add_argument( | ||
| "--force", | ||
| action="store_true", | ||
| help="Force the script to overwrite the current schema with the new schema.", | ||
| ) |
There was a problem hiding this comment.
Until we roll out schema versioning completely we'll need to --force overwrite schema changes.
Also TODO: is add a --release flag that allows overwriting the $id to the prod url, when proposing to staging
5df7391 to
f8ff804
Compare
Resolves #895
This PR gets us 80% of the way to versioned schemas as well