Add schema URL to the meta object #313
Conversation
Added property 'meta.schemaUri' to JSON schemas of Eiffel events. Minor version number of all events increased accordingly.
There was a problem hiding this comment.
Apart from updating the (creating new) schemas, you'd also need to update all markdown files for each event type to include this new parameter.
This PR would benefit from waiting until #282 was solved. There is a preliminary solution to that in Magnus' own clone but there might be some more work to be done there before it can be considered ready for review.
Added property 'meta.schemaUri' to JSON schemas of Eiffel events. Minor version number of all events increased accordingly.
z-sztrom
changed the title
|
Yeah, waiting for #282 would make life easier for everyone; while you'd still have to create 23 new event versions the only difference in the new versions would be a bump in the meta object version reference. Plus you wouldn't have to update the documentation in 23 places, and the rebase of my patch would be less painful. I'm finishing up the documentation but I can publish a draft PR for said issue later this week so that you'll be able to prepare a patch that's based on it. |
|
I've pushed the #315 draft PR that I'd recommend rebasing upon. As I said earlier you still have to create new versions of all events but the change in each file will be minimal. Apart from that you'll need to create a new version of the EiffelMetaProperty schema, found in definitions/EiffelMetaProperty. I've started documenting how things work in eiffel-syntax-and-usage/event-schemas.md and if that text doesn't make any sense please reach out. |
Schema URL property added to EiffelMetaProperty/3.1.0.yml. JSON schemas and corresponding MD documents generated using generate_schemas.py and generate_docs.py respetctively.
| A URI pointing at a location from where the schema used when creating this | ||
| event can be retrieved. The schema on that URI should be considered | ||
| immutable. |
There was a problem hiding this comment.
Would it make sense to hint at why or when this would be useful? I know the background of why Ericsson wants this (well, I think I do anyway) and perhaps it would make sense to include this reason here as an example?
For some reason not the latest files from master have been used for the previous merge. This time it should be OK.
|
I don't understand why, but the merge results were really strange and I didn't notice that. My bad. Fixes submitted. I observed strange behaviour: my local 'git pull' didn't fetch the latest versions from eiffel:master. Only when I cloned completely fresh repo, the latest versions of files appeared. I have never encountered something like that before. |
z-sztrom
requested review from
e-backmark-ericsson and
magnusbaeck
and removed request for
e-backmark-ericsson
There was a problem hiding this comment.
Almost there :-)
I observed strange behaviour: my local 'git pull' didn't fetch the latest versions from eiffel:master. Only when I cloned completely fresh repo, the latest versions of files appeared. I have never encountered something like that before.
Maybe you only fetched the latest from the master branch of your fork and not the upstream remote?
| _history: | ||
| - version: 3.2.0 | ||
| introduced_in: 'No edition set' | ||
| changes: Add schema URL to the meta object (see [Issue 313](https://github.com/eiffel-community/eiffel/issues/313)). |
There was a problem hiding this comment.
Technically, this should be a link to the issue (280) and not the PR (313). But I can live with this and we can clean it up when updating introduced_in as we prepare the release of the Arica edition.
There was a problem hiding this comment.
If it can help to avoid misunderstanding/confusion, I can fix it on Monday. One sed command can fix that.
There was a problem hiding this comment.
Issue number fixed. I hope I didn't break something else:-)
Applicable Issues
Fixes #280
Description of the Change
New property 'meta.schemaUri' has been added to Eiffel JSON schema.
Alternate Designs
Benefits
Particular event's structure can be verified against given JSON schema.
Possible Drawbacks
JSON schema verification takes some time and that might be critical for some applications.
Sign-off
Developer's Certificate of Origin 1.1
By making a contribution to this project, I certify that:
(a) The contribution was created in whole or in part by me and I
have the right to submit it under the open source license
indicated in the file; or
(b) The contribution is based upon previous work that, to the best
of my knowledge, is covered under an appropriate open source
license and I have the right under that license to submit that
work with modifications, whether created in whole or in part
by me, under the same open source license (unless I am
permitted to submit under a different license), as indicated
in the file; or
(c) The contribution was provided directly to me by some other
person who certified (a), (b) or (c) and I have not modified
it.
(d) I understand and agree that this project and the contribution
are public and that a record of the contribution (including all
personal information I submit with it, including my sign-off) is
maintained indefinitely and may be redistributed consistent with
this project or the open source license(s) involved.
Signed-off-by: Roman Szturc roman.szturc.ext@ericsson.com