spec icon indicating copy to clipboard operation
spec copied to clipboard

alignment of file name between examples and schema (both with _ as separator (snake_case))

Open davidB opened this issue 11 months ago • 0 comments

Use the same way to name files in examples & schema, both with _ as separator (snake_case format) : {{subject}}_{{predicate}}.json

Questions

  1. Why not add a number (2 digit) into examples to have the possibility to provide several samples {{subject}}_{{predicate}}_{{number}}.json (e.g. pipelinerun_finished_01.json)

Notes

from @afrittoli

From a spec point of view it has a very small impact, but it has ramifications on logic spread across various repos:

  • A CI job in the spec repo itself that checks examples against schemas
  • Scripts in the tools folder in the spec repo that help with managing versions
  • The logic in the cdevents.dev repo that publishes the schemas on the website -The logic in the various SDKs (go, java, rust and maybe python) that use the spec as a submodule and generate code from the schemas

davidB avatar Mar 03 '24 14:03 davidB