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

Should we document fields null-ability? #93

Open
thejcannon opened this issue Nov 24, 2024 · 1 comment
Open

Should we document fields null-ability? #93

thejcannon opened this issue Nov 24, 2024 · 1 comment

Comments

@thejcannon
Copy link
Contributor

👋

#/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
Copy link
Contributor Author

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant