Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the usage of subject object fields more clearly #113

Closed
e-backmark-ericsson opened this issue Feb 16, 2023 · 0 comments · Fixed by #118
Closed

Document the usage of subject object fields more clearly #113

e-backmark-ericsson opened this issue Feb 16, 2023 · 0 comments · Fixed by #118
Assignees
@afrittoli
Milestone
v0.2

Comments

@e-backmark-ericsson
Copy link
Contributor

e-backmark-ericsson commented Feb 16, 2023 •
edited
Loading

Today all event schemas contain the fields id, source and type in their subject objects, but they are not all described in the corresponding event specific md file. They are explained in the spec.md file, but that is not obvious when reading the event specific md.

It should also be clarified what fields in the subject object are mandatory and not, and what fields have default values.

The type field should maybe have the format of an enum with only one valid value, which should then also be the default value of the type.
@e-backmark-ericsson e-backmark-ericsson mentioned this issue Feb 16, 2023
Merged
4 tasks
@e-backmark-ericsson e-backmark-ericsson added this to the v0.2 milestone Feb 16, 2023
@e-backmark-ericsson e-backmark-ericsson mentioned this issue Feb 17, 2023
Closed
4 tasks
@afrittoli afrittoli mentioned this issue Mar 10, 2023
Merged
4 tasks
afrittoli added a commit to afrittoli/cdevents-spec that referenced this issue Mar 10, 2023
@afrittoli
Improve subject fields spec and schema
b863d9c 
Improve the spec of subject fields for all events:
- link id and source to their spec definitions
- add the type, linked to its spec definition
- include the value of the type for each event

Improve the jsonschema by constraining the subject
type field to the only valid value for each event.

Since all events have been patched already in
v0.2-draft, there's not need to +1 the version
number again within the same spec release.

Fixes: cdevents#113

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
@afrittoli afrittoli self-assigned this Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@afrittoli afrittoli

Labels
None yet
Projects
CDEvents Releases
Status: Done
Milestone
v0.2
Development

Successfully merging a pull request may close this issue.

Improve subject fields spec and schema afrittoli/cdevents-spec
2 participants
@afrittoli @e-backmark-ericsson