Repository navigation
Comparing changes
Open a pull request
base repository: ByteBardOrg/AsyncAPI.NET
base: docs/reference-updates
head repository: ByteBardOrg/AsyncAPI.NET
compare: vnext
- 14 commits
- 34 files changed
- 3 contributors
Commits on Oct 25, 2026
-
docs: use shiki for syntax highlighting (#65)
* docs: document reference escaping, writing and version conversion - references: local references are JSON pointers in a URI, so "/" and "~" in a key are escaped as "~1" and "~0", and the pointer is percent-decoded; add how references are written, including inlining references whose target the written document does not have. - version conversion: list which references stay references and which are written inline, how V2 channel references map to V3 channel keys, and the operations and messages a downgrade drops. - README: drop the JsonPointer.Net attribution, which is no longer a dependency, and fix the ReferenceResolutionSetting name and a server reference example. * docs: highlight code with Shiki Prism's C# grammar has no raw string literals, so the AsyncAPI documents embedded in examples were highlighted as C# code, and as a regex-based grammar it leaves identifiers and properties plain. Its themes also gave types the same color as numbers and booleans. Code blocks now use Shiki with Visual Studio Code's grammars and its Light+ and Dark+ themes, through a swizzled CodeBlock/Content that keeps the theme's line rendering, so line numbers, highlighted lines and the copy button still work. Highlighting is synchronous, so pages render the same on the server and in the browser. C#, JSON, YAML and shell are loaded; other languages render as plain text.
Configuration menu - View commit details
-
Copy full SHA for 78b8b45 - Browse repository at this point
Copy the full SHA 78b8b45View commit details -
docs: list object models in tables, and soften dark mode contrast
Binding pages described their properties in sentences such as "Server fields: ... Channel fields: ...". Each binding page now has an object model section with a table per class: the property, its YAML field, its .NET type and a description, taken from the binding classes, their deserializers and doc comments. Value unions, enums and policy types get their own tables. The Avro guide gets a type reference with a table per schema class, AvroField and the logical types, which were not documented before. The readers, schema parser members and reference resolution settings are tables as well. Dark mode used full white text and grey table and inline code colors on the purple background. Body text is now 80% white and headings 90%, and tables and inline code use neutral tints. Table headers are left-aligned.
Configuration menu - View commit details
-
Copy full SHA for 4b7b594 - Browse repository at this point
Copy the full SHA 4b7b594View commit details
Commits on Oct 30, 2026
-
Configuration menu - View commit details
-
Copy full SHA for 6592b58 - Browse repository at this point
Copy the full SHA 6592b58View commit details -
Configuration menu - View commit details
-
Copy full SHA for b6a36ec - Browse repository at this point
Copy the full SHA b6a36ecView commit details -
Configuration menu - View commit details
-
Copy full SHA for f863e7a - Browse repository at this point
Copy the full SHA f863e7aView commit details -
Update CHANGELOG for version 4.0.0
Updated the changelog for version 4.0.0, detailing bug fixes, features, and breaking changes. Signed-off-by: Alex Wichmann <VisualBean@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 78ef45b - Browse repository at this point
Copy the full SHA 78ef45bView commit details -
Configuration menu - View commit details
-
Copy full SHA for f84f95e - Browse repository at this point
Copy the full SHA f84f95eView commit details -
Configuration menu - View commit details
-
Copy full SHA for 871976a - Browse repository at this point
Copy the full SHA 871976aView commit details -
Update README to remove GitHub Pages deployment note
Removed mention of GitHub Pages configuration for deployment. Signed-off-by: Alex Wichmann <VisualBean@users.noreply.github.com>
Configuration menu - View commit details
-
Copy full SHA for 9ea3fbe - Browse repository at this point
Copy the full SHA 9ea3fbeView commit details -
Configuration menu - View commit details
-
Copy full SHA for 8795da5 - Browse repository at this point
Copy the full SHA 8795da5View commit details -
Configuration menu - View commit details
-
Copy full SHA for cc1e7a5 - Browse repository at this point
Copy the full SHA cc1e7a5View commit details
Commits on Nov 5, 2026
-
fix: align identifier validation with spec constraints (#68)
* fix: align identifier validation with spec constraints Use URL-safe ASCII identifier keys (letters, digits, dots, underscores, and hyphens) as the library baseline, with stricter rules wherever the specification requires them. - Reject dots in server keys. - Restrict component keys to ASCII. - Preserve the existing channel-key restriction. - Correct channel-address expression detection to include 0 and require nonempty names. - Add regression coverage for validation and parameter serialization. Compatibility: dotted server keys and Unicode component keys now produce validation errors, while their values remain preserved in the model. * fix(validation): reject server keys containing newlines Use the strict \z end-of-string anchor for server key validation so keys with a trailing newline cannot pass through the $ anchor. Add regression cases for trailing LF, CRLF, and embedded newlines in AsyncAPI 2.6.0 and 3.0.0. Escape carriage returns and newlines in double-quoted YAML keys so the tests preserve these characters for validation.
Configuration menu - View commit details
-
Copy full SHA for 2d0c046 - Browse repository at this point
Copy the full SHA 2d0c046View commit details
Commits on Nov 11, 2026
-
Configuration menu - View commit details
-
Copy full SHA for cf14ea7 - Browse repository at this point
Copy the full SHA cf14ea7View commit details -
Configuration menu - View commit details
-
Copy full SHA for 3dc1870 - Browse repository at this point
Copy the full SHA 3dc1870View commit details
This comparison is taking too long to generate.
Unfortunately it looks like we can’t render this comparison for you right now. It might be too big, or there might be something weird with your repository.
You can try running this command locally to see the comparison on your machine:
git diff docs/reference-updates...vnext