Skip to content

add note about getting a textual representation #18

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 10, 2024
Merged

add note about getting a textual representation #18

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2fee432
add note about getting a textual representation
gregsdennis May 30, 2024
ba89998
make the note part of the main text instead of just a tip
gregsdennis May 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file modified .jekyll-metadata
View file
Open in desktop
Binary file not shown.
7 changes: 6 additions & 1 deletion _docs/schema/basics.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,9 @@ There are two options when building a schema: defining it inline using the fluen

## Serialization and Deserialization {#schema-deserialization}

_JsonSchema.Net_ schemas are fully serializable.
Serialization is how we convert between the textual representation of JSON Schema and a `JsonSchema` .Net object. In many cases, you'll compose your schemas in separate JSON files and deserialize them into the `JsonSchema` model. However if you [define your schemas in code](#schema-inlining) or [generate them from a type](/schema/schemagen/schema-generation/) you won't have a textual representation of those schemas on hand.

To facilitate this, _JsonSchema.Net_ schemas are fully serializable.

```c#
var mySchema = JsonSchema.FromText(content);
Expand All @@ -61,6 +63,9 @@ var mySchema = JsonSerializer.Deserialize<JsonSchema>(content);

Done.

> You can either use the JSON serializer as shown above, or the YAML serializer found in [_Yaml2JsonNode_](/yaml/basics/).
{: .prompt-tip}

### Ahead of Time (AOT) compatibility {#aot}

_JsonSchema.Net_ v6 includes updates to support [Native AOT applications](https://learn.microsoft.com/en-us/dotnet/core/deploying/native-aot/). In order to take advantage of this, there are a few things you'll need to do.
Expand Down