deploy: christianhelle/refitter@e6aec13

Refitter · Jan 17, 2025 · 78176c3 · 78176c3
1 parent a6e44b6
commit 78176c3
Show file tree

Hide file tree

Showing 4 changed files with 107 additions and 12 deletions.
diff --git a/api/Refitter.Core.RefitGenerator.html b/api/Refitter.Core.RefitGenerator.html
@@ -230,7 +230,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="Refitter_Core_RefitGenerator_Generate" data-uid="Refitter.Core.RefitGenerator.Generate">
   Generate()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/RefitGenerator.cs/#L122"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/RefitGenerator.cs/#L126"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Generates Refit clients and interfaces based on an OpenAPI specification and returns the generated code as a string.</p>
@@ -263,7 +263,7 @@ <h4 class="section">Returns</h4>
 
   <h3 id="Refitter_Core_RefitGenerator_GenerateMultipleFiles" data-uid="Refitter.Core.RefitGenerator.GenerateMultipleFiles">
   GenerateMultipleFiles()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/RefitGenerator.cs/#L162"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/RefitGenerator.cs/#L166"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"></div>

diff --git a/api/Refitter.Core.RefitGeneratorSettings.html b/api/Refitter.Core.RefitGeneratorSettings.html
@@ -313,7 +313,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="Refitter_Core_RefitGeneratorSettings_ApizrSettings" data-uid="Refitter.Core.RefitGeneratorSettings.ApizrSettings">
   ApizrSettings
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L209"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L216"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Get ot set the settings describing how to configure Apizr</p>
@@ -568,7 +568,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="Refitter_Core_RefitGeneratorSettings_GenerateDefaultAdditionalProperties" data-uid="Refitter.Core.RefitGeneratorSettings.GenerateDefaultAdditionalProperties">
   GenerateDefaultAdditionalProperties
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L199"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L206"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Set to <code>false</code> to skip default additional properties. Default is <code>true</code></p>
@@ -664,7 +664,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="Refitter_Core_RefitGeneratorSettings_GenerateMultipleFiles" data-uid="Refitter.Core.RefitGeneratorSettings.GenerateMultipleFiles">
   GenerateMultipleFiles
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L224"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L231"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Set to <code>true</code> to generate multiple files. Default is <code>false</code>
@@ -797,7 +797,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="Refitter_Core_RefitGeneratorSettings_ImmutableRecords" data-uid="Refitter.Core.RefitGeneratorSettings.ImmutableRecords">
   ImmutableRecords
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L204"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L211"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Set to <code>true</code> to generate contracts as immutable records instead of classes</p>
@@ -825,6 +825,40 @@ <h4 class="section">Property Value</h4>
 
 
 
+  <a id="Refitter_Core_RefitGeneratorSettings_IncludeInheritanceHierarchy_" data-uid="Refitter.Core.RefitGeneratorSettings.IncludeInheritanceHierarchy*"></a>
+
+  <h3 id="Refitter_Core_RefitGeneratorSettings_IncludeInheritanceHierarchy" data-uid="Refitter.Core.RefitGeneratorSettings.IncludeInheritanceHierarchy">
+  IncludeInheritanceHierarchy
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L195"><i class="bi bi-code-slash"></i></a>
+  </h3>
+
+  <div class="markdown level1 summary"><p>Set to <code>true</code> to keep all possible type-instances of inheritance/union types.
+If this is <code>false</code> only directly referenced types will be kept.
+This works in conjunction with <a class="xref" href="Refitter.Core.RefitGeneratorSettings.html#Refitter_Core_RefitGeneratorSettings_TrimUnusedSchema">TrimUnusedSchema</a>.</p>
+</div>
+  <div class="markdown level1 conceptual"></div>
+
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public bool IncludeInheritanceHierarchy { get; set; }</code></pre>
+  </div>
+
+
+
+
+
+  <h4 class="section">Property Value</h4>
+  <dl class="parameters">
+    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
+    <dd></dd>
+  </dl>
+
+
+
+
+
+
+
+
   <a id="Refitter_Core_RefitGeneratorSettings_IncludePathMatches_" data-uid="Refitter.Core.RefitGeneratorSettings.IncludePathMatches*"></a>
 
   <h3 id="Refitter_Core_RefitGeneratorSettings_IncludePathMatches" data-uid="Refitter.Core.RefitGeneratorSettings.IncludePathMatches">
@@ -1055,7 +1089,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="Refitter_Core_RefitGeneratorSettings_OperationNameGenerator" data-uid="Refitter.Core.RefitGeneratorSettings.OperationNameGenerator">
   OperationNameGenerator
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L193"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L200"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>The NSwag IOperationNameGenerator implementation to use</p>
@@ -1219,7 +1253,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="Refitter_Core_RefitGeneratorSettings_ParameterNameGenerator" data-uid="Refitter.Core.RefitGeneratorSettings.ParameterNameGenerator">
   ParameterNameGenerator
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L236"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L243"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"></div>
@@ -1446,7 +1480,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="Refitter_Core_RefitGeneratorSettings_UseDynamicQuerystringParameters" data-uid="Refitter.Core.RefitGeneratorSettings.UseDynamicQuerystringParameters">
   UseDynamicQuerystringParameters
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L215"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L222"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Set to <code>true</code> to wrap multiple query parameters into a single complex one. Default is <code>false</code> (no wrapping).
@@ -1512,7 +1546,7 @@ <h4 class="section">Property Value</h4>
 
   <h3 id="Refitter_Core_RefitGeneratorSettings_UsePolymorphicSerialization" data-uid="Refitter.Core.RefitGeneratorSettings.UsePolymorphicSerialization">
   UsePolymorphicSerialization
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L234"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/Settings/RefitGeneratorSettings.cs/#L241"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"><p>Set to <code>true</code> to use System.Text.Json polymorphic serialization. Default is <code>false</code>

diff --git a/api/Refitter.Core.SchemaCleaner.html b/api/Refitter.Core.SchemaCleaner.html
@@ -152,7 +152,7 @@ <h2 class="section" id="constructors">Constructors
 
   <h3 id="Refitter_Core_SchemaCleaner__ctor_NSwag_OpenApiDocument_System_String___" data-uid="Refitter.Core.SchemaCleaner.#ctor(NSwag.OpenApiDocument,System.String[])">
   SchemaCleaner(OpenApiDocument, string[])
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/SchemaCleaner.cs/#L12"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/SchemaCleaner.cs/#L14"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"></div>
@@ -181,6 +181,41 @@ <h4 class="section">Parameters</h4>
 
 
 
+  <h2 class="section" id="properties">Properties
+</h2>
+
+
+  <a id="Refitter_Core_SchemaCleaner_IncludeInheritanceHierarchy_" data-uid="Refitter.Core.SchemaCleaner.IncludeInheritanceHierarchy*"></a>
+
+  <h3 id="Refitter_Core_SchemaCleaner_IncludeInheritanceHierarchy" data-uid="Refitter.Core.SchemaCleaner.IncludeInheritanceHierarchy">
+  IncludeInheritanceHierarchy
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/SchemaCleaner.cs/#L12"><i class="bi bi-code-slash"></i></a>
+  </h3>
+
+  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 conceptual"></div>
+
+  <div class="codewrapper">
+    <pre><code class="lang-csharp hljs">public bool IncludeInheritanceHierarchy { get; set; }</code></pre>
+  </div>
+
+
+
+
+
+  <h4 class="section">Property Value</h4>
+  <dl class="parameters">
+    <dt><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.boolean">bool</a></dt>
+    <dd></dd>
+  </dl>
+
+
+
+
+
+
+
+
   <h2 class="section" id="methods">Methods
 </h2>
 
@@ -189,7 +224,7 @@ <h2 class="section" id="methods">Methods
 
   <h3 id="Refitter_Core_SchemaCleaner_RemoveUnreferencedSchema" data-uid="Refitter.Core.SchemaCleaner.RemoveUnreferencedSchema">
   RemoveUnreferencedSchema()
-  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/SchemaCleaner.cs/#L18"><i class="bi bi-code-slash"></i></a>
+  <a class="header-action link-secondary" title="View source" href="https://github.com/christianhelle/refitter/blob/main/src/Refitter.Core/SchemaCleaner.cs/#L20"><i class="bi bi-code-slash"></i></a>
   </h3>
 
   <div class="markdown level1 summary"></div>

diff --git a/xrefmap.yml b/xrefmap.yml
@@ -1277,6 +1277,19 @@ references:
   isSpec: "True"
   fullName: Refitter.Core.RefitGeneratorSettings.ImmutableRecords
   nameWithType: RefitGeneratorSettings.ImmutableRecords
+- uid: Refitter.Core.RefitGeneratorSettings.IncludeInheritanceHierarchy
+  name: IncludeInheritanceHierarchy
+  href: api/Refitter.Core.RefitGeneratorSettings.html#Refitter_Core_RefitGeneratorSettings_IncludeInheritanceHierarchy
+  commentId: P:Refitter.Core.RefitGeneratorSettings.IncludeInheritanceHierarchy
+  fullName: Refitter.Core.RefitGeneratorSettings.IncludeInheritanceHierarchy
+  nameWithType: RefitGeneratorSettings.IncludeInheritanceHierarchy
+- uid: Refitter.Core.RefitGeneratorSettings.IncludeInheritanceHierarchy*
+  name: IncludeInheritanceHierarchy
+  href: api/Refitter.Core.RefitGeneratorSettings.html#Refitter_Core_RefitGeneratorSettings_IncludeInheritanceHierarchy_
+  commentId: Overload:Refitter.Core.RefitGeneratorSettings.IncludeInheritanceHierarchy
+  isSpec: "True"
+  fullName: Refitter.Core.RefitGeneratorSettings.IncludeInheritanceHierarchy
+  nameWithType: RefitGeneratorSettings.IncludeInheritanceHierarchy
 - uid: Refitter.Core.RefitGeneratorSettings.IncludePathMatches
   name: IncludePathMatches
   href: api/Refitter.Core.RefitGeneratorSettings.html#Refitter_Core_RefitGeneratorSettings_IncludePathMatches
@@ -1588,6 +1601,19 @@ references:
   fullName.vb: Refitter.Core.SchemaCleaner.New
   nameWithType: SchemaCleaner.SchemaCleaner
   nameWithType.vb: SchemaCleaner.New
+- uid: Refitter.Core.SchemaCleaner.IncludeInheritanceHierarchy
+  name: IncludeInheritanceHierarchy
+  href: api/Refitter.Core.SchemaCleaner.html#Refitter_Core_SchemaCleaner_IncludeInheritanceHierarchy
+  commentId: P:Refitter.Core.SchemaCleaner.IncludeInheritanceHierarchy
+  fullName: Refitter.Core.SchemaCleaner.IncludeInheritanceHierarchy
+  nameWithType: SchemaCleaner.IncludeInheritanceHierarchy
+- uid: Refitter.Core.SchemaCleaner.IncludeInheritanceHierarchy*
+  name: IncludeInheritanceHierarchy
+  href: api/Refitter.Core.SchemaCleaner.html#Refitter_Core_SchemaCleaner_IncludeInheritanceHierarchy_
+  commentId: Overload:Refitter.Core.SchemaCleaner.IncludeInheritanceHierarchy
+  isSpec: "True"
+  fullName: Refitter.Core.SchemaCleaner.IncludeInheritanceHierarchy
+  nameWithType: SchemaCleaner.IncludeInheritanceHierarchy
 - uid: Refitter.Core.SchemaCleaner.RemoveUnreferencedSchema
   name: RemoveUnreferencedSchema()
   href: api/Refitter.Core.SchemaCleaner.html#Refitter_Core_SchemaCleaner_RemoveUnreferencedSchema