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.

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

Add a schema uri property to the context #91

Closed
e-backmark-ericsson opened this issue Nov 15, 2022 · 0 comments · Fixed by #184
Closed

Add a schema uri property to the context #91

e-backmark-ericsson opened this issue Nov 15, 2022 · 0 comments · Fixed by #184
Labels
roadmap Items on the roadmap

Comments

@e-backmark-ericsson
Copy link
Contributor

To simplify for event consumer we should include a schema uri property to the cdevents context object. With that the consumer could use that schema for validation, parsing and data extraction purposes. It might be obvious that an event sent using a certain version of the spec would be possible to retrieve from https://cdevents.dev//schema/.json, but there are use cases where that might not be enough:

  • If the event sender is not allowed to communicate with sites on Internet and would instead point at an internally managed schema registry serving the event schemas
  • If cdevents.dev is not seen as reliable enough when it comes to performance and availability, and thus a reference to a more robust schema registry could be provided
  • If the organization wants to limit the value range or optional parameters provided in the events and thus will provide references to a different schema registry than cdevents.dev to show what actual schemas where used when producing the event sent. It could for example limit some values in test suite/case events differently depending on what tool is used in a specific test activity.
@afrittoli afrittoli moved this to Todo in CDEvents Releases Dec 13, 2022
@afrittoli afrittoli added the roadmap Items on the roadmap label Dec 13, 2022
@afrittoli afrittoli added this to the v0.3 milestone Mar 16, 2023
@afrittoli afrittoli removed this from the v0.3 milestone Mar 27, 2023
afrittoli added a commit to afrittoli/cdevents-spec that referenced this issue Feb 22, 2024
Add schemaURI to the context. It can be used to link to
a custom schema that further refines the event content.

Context:
- cdevents#168
- cdevents#91

Fixes: cdevents#91

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
afrittoli added a commit that referenced this issue Mar 4, 2024
* Add an optional schemaURI to the context

Add schemaURI to the context. It can be used to link to
a custom schema that further refines the event content.

Context:
- #168
- #91

Fixes: #91

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
@github-project-automation github-project-automation bot moved this from Todo to Done in CDEvents Releases Mar 4, 2024
afrittoli added a commit to afrittoli/cdevents-spec that referenced this issue Mar 6, 2024
Add schemaURI to the context. It can be used to link to
a custom schema that further refines the event content.

Context:
- cdevents#168
- cdevents#91

Fixes: cdevents#91

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
afrittoli added a commit to afrittoli/cdevents-spec that referenced this issue Mar 13, 2024
Add schemaURI to the context. It can be used to link to
a custom schema that further refines the event content.

Context:
- cdevents#168
- cdevents#91

Fixes: cdevents#91

Signed-off-by: Andrea Frittoli <andrea.frittoli@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
roadmap Items on the roadmap
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

2 participants