search

buildkite / pipeline-schema

A JSON schema for Buildkite’s pipeline file format
MIT License
31 stars 35 forks source link

Should we document fields `null`-ability? #93

Open thejcannon opened 2 days ago

thejcannon commented 2 days ago

👋

#/definitions/waitStep/wait having {"type": "null"} is a bit of an outlier (only one other instance, and its #/definitions/dependsOn).

I'm guessing it is documented because wait step docs explicitly call out null as a value you can use. However, from some light testing, BK is totally fine with other fields being null too!

steps:
  - trigger: foo
     depends_on: ~
     key: ~
  - command: bar
     env: ~
     retry: ~

So, curious if, for correctness sake, most fields should be exploded into support null, or if for conciseness they shouldn't.

thejcannon commented 1 day ago

Another example of null in the schema id #/definitions/groupStep/properties/group/type