Add readOnly annotations to JSON schema and filter in PyDABs#4415
Draft
shreyas-goenka wants to merge 8 commits intomainfrom
Draft
Add readOnly annotations to JSON schema and filter in PyDABs#4415shreyas-goenka wants to merge 8 commits intomainfrom
shreyas-goenka wants to merge 8 commits intomainfrom
Conversation
This file contains hidden or 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
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.
Summary
This PR adds
readOnlyanddoNotSuggestannotations to the JSON schema for fields that are computed at runtime and should not be set by users.Builds on: #4414
Changes
JSON Schema
ReadOnlyfield to the Schema struct (standard JSON schema annotation)bundle:"readonly"tag are now marked withreadOnly: trueanddoNotSuggest: trueOUTPUT_ONLYin OpenAPI spec getreadOnly: trueanddoNotSuggest: truePyDABs Code Generation
read_onlyfield to the Property dataclass to parsereadOnlyfrom schemaremove_readonly_fields()function to filter out readonly fields from code generationcreate_time,id,lifecycle_stateare now excluded from generated Python codeTest plan
🤖 Generated with Claude Code