Fix documentation typos in serialization comments#3057
Merged
Alekhya-Polavarapu merged 2 commits intodev/alpolava/cherrypick_serializationfrom Jan 14, 2026
Merged
Conversation
1 task
Co-authored-by: Alekhya-Polavarapu <[email protected]>
Copilot
AI
changed the title
[WIP] Fix serialization/deserialization issue with $ prefix columns
Fix documentation typos in serialization comments
Jan 14, 2026
Alekhya-Polavarapu
approved these changes
Jan 14, 2026
Alekhya-Polavarapu
requested review from
Aniruddh25,
RubenCerna2079,
aaronburtle,
anushakolan,
neeraj-sharma2592,
rusamant,
sourabh1007,
souvikghosh04 and
vadeveka
as code owners
Alekhya-Polavarapu
merged commit 1b8a646
into
dev/alpolava/cherrypick_serialization
1 of 2 checks passed
Alekhya-Polavarapu
added a commit
that referenced
this pull request
Jan 15, 2026
) Serialization and deserialization of metadata currently fail when column names are prefixed with the $ symbol. This issue occurs because we’ve enabled the ReferenceHandler flag in our System.Text.Json serialization settings. When this flag is active, the serializer treats $ as a reserved character used for special metadata (e.g., $id, $ref). As a result, any property name starting with $ is interpreted as metadata and cannot be deserialized properly. This update introduces custom logic in the converter’s Write and Read methods to handle $-prefixed column names safely. - During serialization, columns beginning with $ are escaped as "_$". - During deserialization, this transformation is reversed to restore the original property names. - [x] Unit tests --------- Co-authored-by: Aniruddh Munde <[email protected]> Fix serialization for StoredProcedureDefinition inheritance (#3045) - To apply correct serialization and deserialization logic for stored procedures. With the previous changes, serialization was not working correctly for the StoredProcedureDefinition type, which extends SourceDefinition. When the value type was passed explicitly for serialization, the parent type was used instead, causing some child-type properties to be omitted. Instead of manually specifying the value type during serialization, this change allows the library to infer the type automatically and perform the correct serialization. - [x] Unit Tests --------- Co-authored-by: Aniruddh Munde <[email protected]> Update src/Core/Services/MetadataProviders/Converters/DatabaseObjectConverter.cs Co-authored-by: Copilot <[email protected]> Fix documentation typos in serialization comments (#3057) Code review identified typos in XML documentation comments that inaccurately described the escaping mechanism and contained spelling errors. Fixed documentation comments to accurately reflect the implementation: - **DatabaseObjectConverter.cs**: Updated escape/unescape method summaries to correctly describe the `DAB_ESCAPE$` prefix transformation (previously incorrectly documented as `_$`) - **SerializationDeserializationTests.cs**: Corrected "deserilization" → "deserialization" in three test method comments - [x] Documentation-only change, no functional changes <!-- START COPILOT CODING AGENT TIPS --> --- 💬 We'd love your input! Share your thoughts on Copilot coding agent in our [2 minute survey](https://gh.io/copilot-coding-agent-survey). --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: Alekhya-Polavarapu <[email protected]>
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.
Why make this change?
Code review identified typos in XML documentation comments that inaccurately described the escaping mechanism and contained spelling errors.
What is this change?
Fixed documentation comments to accurately reflect the implementation:
DAB_ESCAPE$prefix transformation (previously incorrectly documented as_$)How was this tested?
💬 We'd love your input! Share your thoughts on Copilot coding agent in our 2 minute survey.