From 0bdcb094aee81b734a0f0dc165ff11e37e35102f Mon Sep 17 00:00:00 2001 From: "dependabot[bot]" <49699333+dependabot[bot]@users.noreply.github.com> Date: Mon, 8 Apr 2024 02:18:21 +0000 Subject: [PATCH 1/5] Bump docfx from 2.74.0 to 2.76.0 Bumps [docfx](https://github.com/dotnet/docfx) from 2.74.0 to 2.76.0. - [Release notes](https://github.com/dotnet/docfx/releases) - [Changelog](https://github.com/dotnet/docfx/blob/main/RELEASENOTE.md) - [Commits](https://github.com/dotnet/docfx/compare/v2.74.0...v2.76.0) --- updated-dependencies: - dependency-name: docfx dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] --- .config/dotnet-tools.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.config/dotnet-tools.json b/.config/dotnet-tools.json index b255005e33..f161416014 100644 --- a/.config/dotnet-tools.json +++ b/.config/dotnet-tools.json @@ -21,7 +21,7 @@ ] }, "docfx": { - "version": "2.74.0", + "version": "2.76.0", "commands": [ "docfx" ] From 6508f8b7408a524154087f72b705d5cc8ed2526d Mon Sep 17 00:00:00 2001 From: Bart Koelman <10324372+bkoelman@users.noreply.github.com> Date: Tue, 9 Apr 2024 01:33:46 +0200 Subject: [PATCH 2/5] Hide toc from generated examples page --- docs/request-examples/index.md | 4 ++++ docs/request-examples/toc.md | 0 2 files changed, 4 insertions(+) create mode 100644 docs/request-examples/toc.md diff --git a/docs/request-examples/index.md b/docs/request-examples/index.md index c34b3d713a..614aa4814f 100644 --- a/docs/request-examples/index.md +++ b/docs/request-examples/index.md @@ -1,3 +1,7 @@ +--- +_disableToc: true +--- + # Example requests These requests have been generated against the "GettingStarted" application and are updated on every deployment. diff --git a/docs/request-examples/toc.md b/docs/request-examples/toc.md new file mode 100644 index 0000000000..e69de29bb2 From 457a4fe80011230b3bd940de81270009327ca1b3 Mon Sep 17 00:00:00 2001 From: Bart Koelman <10324372+bkoelman@users.noreply.github.com> Date: Tue, 9 Apr 2024 01:34:16 +0200 Subject: [PATCH 3/5] Exclude README.md files from docs website --- docs/docfx.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/docfx.json b/docs/docfx.json index 1d0e192ac2..eb94da412e 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -24,6 +24,9 @@ "internals/**.md", "toc.yml", "*.md" + ], + "exclude": [ + "**/README.md" ] } ], From 79d0648f24686ac57048046979fdaf847d0df812 Mon Sep 17 00:00:00 2001 From: Bart Koelman <10324372+bkoelman@users.noreply.github.com> Date: Tue, 9 Apr 2024 01:55:28 +0200 Subject: [PATCH 4/5] Fix lists in doc-comments --- .../FieldChains/FieldChainPattern.cs | 20 +++++++++++++++---- 1 file changed, 16 insertions(+), 4 deletions(-) diff --git a/src/JsonApiDotNetCore/QueryStrings/FieldChains/FieldChainPattern.cs b/src/JsonApiDotNetCore/QueryStrings/FieldChains/FieldChainPattern.cs index 4928984030..fb63c6a03d 100644 --- a/src/JsonApiDotNetCore/QueryStrings/FieldChains/FieldChainPattern.cs +++ b/src/JsonApiDotNetCore/QueryStrings/FieldChains/FieldChainPattern.cs @@ -49,7 +49,7 @@ internal FieldChainPattern(FieldTypes choices, bool atLeastOne, bool atMostOne, /// /// /// Patterns are similar to regular expressions, but a lot simpler. They consist of a sequence of terms. A term can be a single character or a character - /// choice, optionally followed by a quantifier. + /// choice. A term is optionally followed by a quantifier. ///

/// The following characters can be used: /// @@ -58,18 +58,26 @@ internal FieldChainPattern(FieldTypes choices, bool atLeastOne, bool atMostOne, /// /// Matches a to-many relationship. /// + /// + /// /// O /// /// Matches a to-one relationship. /// + /// + /// /// R /// /// Matches a relationship. /// + /// + /// /// A /// /// Matches an attribute. /// + /// + /// /// F /// /// Matches a field. @@ -86,15 +94,19 @@ internal FieldChainPattern(FieldTypes choices, bool atLeastOne, bool atMostOne, /// /// ? /// - /// Matches its term zero or one times. + /// Matches its preceding term zero or one times. /// + /// + /// /// * /// - /// Matches its term zero or more times. + /// Matches its preceding term zero or more times. /// + /// + /// /// + /// - /// Matches its term one or more times. + /// Matches its preceding term one or more times. /// /// /// From f7462c3cf349d5e06b507d14d2705365fc892094 Mon Sep 17 00:00:00 2001 From: Bart Koelman <10324372+bkoelman@users.noreply.github.com> Date: Tue, 9 Apr 2024 02:03:16 +0200 Subject: [PATCH 5/5] Convert code blocks in lists to inline code --- .../Request/Adapters/IDocumentAdapter.cs | 8 ++++---- .../Serialization/Response/IResponseModelAdapter.cs | 12 ++++++------ 2 files changed, 10 insertions(+), 10 deletions(-) diff --git a/src/JsonApiDotNetCore/Serialization/Request/Adapters/IDocumentAdapter.cs b/src/JsonApiDotNetCore/Serialization/Request/Adapters/IDocumentAdapter.cs index 794278fc73..5480d41c01 100644 --- a/src/JsonApiDotNetCore/Serialization/Request/Adapters/IDocumentAdapter.cs +++ b/src/JsonApiDotNetCore/Serialization/Request/Adapters/IDocumentAdapter.cs @@ -13,22 +13,22 @@ public interface IDocumentAdapter /// /// /// - /// ]]> (operations) + /// ]]> (operations) /// /// /// /// - /// ]]> (to-many relationship, unknown relationship) + /// ]]> (to-many relationship, unknown relationship) /// /// /// /// - /// (resource, to-one relationship) + /// (resource, to-one relationship) /// /// /// /// - /// (to-one relationship) + /// (to-one relationship) /// /// /// diff --git a/src/JsonApiDotNetCore/Serialization/Response/IResponseModelAdapter.cs b/src/JsonApiDotNetCore/Serialization/Response/IResponseModelAdapter.cs index f458edf33a..49b0f65c95 100644 --- a/src/JsonApiDotNetCore/Serialization/Response/IResponseModelAdapter.cs +++ b/src/JsonApiDotNetCore/Serialization/Response/IResponseModelAdapter.cs @@ -12,32 +12,32 @@ public interface IResponseModelAdapter /// /// /// - /// ]]> + /// ]]> /// /// /// /// - /// + /// /// /// /// /// - /// + /// /// /// /// /// - /// ]]> + /// ]]> /// /// /// /// - /// ]]> + /// ]]> /// /// /// /// - /// + /// /// /// ///