Fix/nested class ref sanitization#78
Closed
lior1997k wants to merge 5 commits into
Closed
Conversation
GetSchemaTypeId() now percent-encodes [ ] < > characters in type IDs to produce valid JSON Schema $ref URI-reference keys. This fixes invalid $defs keys like System.String[] and IEnumerable<System.Int32> which violate RFC 3986. Also updates TestSchemaTypeId assertions to match the new sanitized output. Ultraworked with Sisyphus Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai>
Contributor
Author
|
Thanks for catching the nested-class case. I opened this follow-up PR to encode Let me know if this direction looks good or if you prefer another encoding approach. |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR updates how schema type identifiers are produced so that nested types, arrays, and generics generate “sanitized” IDs intended to be safer when used inside JSON Schema $ref fragments.
Changes:
- Route
GetSchemaTypeId(...)through a new sanitization step that percent-encodes certain characters ([]<>+). - Add a new test for nested type IDs and update existing schema type-id tests to assert the new encoded outputs.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
ReflectorNet/src/Utils/TypeUtils.Name.cs |
Changes GetSchemaTypeId to return a percent-encoded variant of GetTypeId, adding SanitizeForJsonSchemaRef. |
ReflectorNet.Tests/src/SchemaTests/TestSchemaTypeId.cs |
Adds coverage for nested types and updates expectations for arrays/generics to match the newly encoded IDs. |
Comment on lines
+118
to
+131
| public static string GetSchemaTypeId<T>() => GetSchemaTypeId(typeof(T)); | ||
| public static string GetSchemaTypeId(Type type) | ||
| { | ||
| var typeId = GetTypeId(type); | ||
| return SanitizeForJsonSchemaRef(typeId); | ||
| } | ||
|
|
||
| private static string SanitizeForJsonSchemaRef(string typeId) | ||
| { | ||
| if (string.IsNullOrEmpty(typeId)) | ||
| return typeId; | ||
| return typeId.Replace("[", "%5B").Replace("]", "%5D") | ||
| .Replace("<", "%3C").Replace(">", "%3E") | ||
| .Replace("+", "%2B"); |
Comment on lines
+12
to
+36
| @@ -18,7 +33,7 @@ public void GetSchemaTypeId_SimpleArray_ShouldAppendArray() | |||
| var result = type.GetSchemaTypeId(); | |||
|
|
|||
| // Assert | |||
| Assert.Equal($"System.Int32{TypeUtils.ArraySuffix}", result); | |||
| Assert.Equal("System.Int32%5B%5D", result); | |||
…a tests instead of hardcoding
…n' into fix/nested-class-ref-sanitization
Owner
|
Use the first PR which you made to add this changes there. Don't need to add new PRs for the same thing |
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.
No description provided.