Add optional attribute to spec #6
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
The current Recap null-field handling is a bit cumbersome. I discussed with @gwukelic, @adrianisk, and @cpard. We decided to add support for an `optional` field to the CST. This will allow us to specify that a field is optional. See the conversation here: gabledata/recap#335 Users can now specify an optional field as: ```yaml type: struct fields: - name: secondary_phone type: string32 optional: true ``` This will get treated the same as: ```yaml type: struct fields: - name: secondary_phone type: "union", types: ["null", "string32"], default: null ```
gwukelic
reviewed
Jul 31, 2023
specs/type/0.2.0.md
Outdated
| # A union type of null or a 32-bit signed int | ||
| type: union | ||
| types: | ||
| - type: null |
There was a problem hiding this comment.
Does this work now? I'm worried that null (without quotes) still won't work. If so, we should update the examples to use "null" (with quotes).
There was a problem hiding this comment.
Ah, good catch. Updated.
YAML coerces `null` to a null literal (None in Python) rather than a string
literal ("null"). The examples should say `"null"` since all type attribues in
Recap have a string literal value.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The current Recap null-field handling is a bit cumbersome. I discussed with
@gwukelic, @adrianisk, and @cpard. We decided to add support for an
optionalfield to the CST. This will allow us to specify that a field is optional.
See the conversation here:
gabledata/recap#335
Users can now specify an optional field as:
This will get treated the same as: