Enhance array properties with item type metadata and nested structures #163
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 latest updates on your projects. Learn more about Vercel for Git ↗︎
|
razor-x
reviewed
Feb 28, 2025
src/lib/blueprint.ts
Outdated
| @@ -251,6 +251,15 @@ interface RecordProperty extends BaseProperty { | |||
| interface ListProperty extends BaseProperty { | |||
| format: 'list' | |||
| jsonType: 'array' | |||
| itemFormat?: Property['format'] | 'discriminated_object' | |||
There was a problem hiding this comment.
Instead of all of these optional values, we should follow the pattern already established by properly defining what kind of array properties we expect.
interface StringListProperty extends ListProperty {
itemFormat: 'string'
}
interface NumberListProperty extends ListProperty {
itemFormat: 'number'
}
interface EnumListProperty extends ListProperty {
itemFormat: 'enum'
itemsValues: EnumValue[]
}
interface ObjectListProperty extends ListProperty {
itemFormat: 'object'
itemProperties: Property[]
}
interface DiscriminatedListProperty extends ListProperty {
itemFormat: 'object'
itemDiscriminatorKey: string
itemVariants: Array<{
variantName: string // the discriminator value
properties: Property[]
description: string
}>
}
* Move Seam extensions into seam.js * feat: Allow null routePath for some resources * ci: Format code * Move pagination to blueprint * Add pagination to fixture * ci: Generate code * ci: Format code * Make pagination nullable * Add createPagination * ci: Generate code * Implement createPagination * Implement hasPagination * Update src/lib/blueprint.ts * Use responseKey over paginationResponseKey * ci: Generate code * Use paginationResponseKey via openapi.components.schemas * Update fixture --------- Co-authored-by: Seam Bot <seambot@getseam.com>
…164) Co-authored-by: Seam Bot <seambot@getseam.com>
razor-x
approved these changes
Feb 28, 2025
Co-authored-by: Evan Sosenko <evan@getseam.com>
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.