docs: documenting the different types of Object Definitions #3135
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
stephybun
reviewed
Oct 10, 2023
Comment on lines
+25
to
+26
| * A CSV of a String | ||
| * A List of a String |
There was a problem hiding this comment.
Could we provide an actual example of these? like is the CSV apple,pear,strawberry but a list of a string is ["apple","pear","strawberry"]?
|
|
||
| Notes: | ||
|
|
||
| * At present the Object Definition type is reused, but shouldn't be, as we'll want to extend this in the future when we parse Data Plane (which has way more possible values for types). |
There was a problem hiding this comment.
Could we be explicit about what specifically is missing here? e.g.
- add an Options Object Definition type
- add a Terraform Object Definition type
|
|
||
| Notes: | ||
|
|
||
| * In retrospect this should probably be named `SDKObjectDefinition` |
There was a problem hiding this comment.
Is this a rename that we should undertake? It's unclear what this sentence is trying to convey or add.
|
In the end we ended up deciding to document these inline within the new SDK types, so I'm going to close this out:
|
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.
No description provided.