GenerationSource Class

Summary

Base class for metadata sources
Assembly
Cake.NSwag.dll
Namespace
Cake.NSwag.Sources
Base Types
  • Object
Derived Types
graph BT Type-->Base0["Object"] Type["GenerationSource"] class Type type-node Derived0["JsonSchemaSource"]-->Type click Derived0 "/api/Cake.NSwag.Sources/JsonSchemaSource" Derived1["AssemblySource"]-->Type click Derived1 "/api/Cake.NSwag.Sources/AssemblySource" Derived2["SwaggerSource"]-->Type click Derived2 "/api/Cake.NSwag.Sources/SwaggerSource"

Syntax

public abstract class GenerationSource

Constructors

Name Summary
GenerationSource(FilePath, ICakeEnvironment, IFileSystem) Initializes a new instance of the GenerationSource class.

Properties

Name Value Summary
Environment ICakeEnvironment
The Cake environment
FileSystem IFileSystem
The file system
Source FilePath
Source file for API metadata.

Extension Methods

Name Value Summary
Dump<GenerationSource>() string
Get a basic string representation of specified object.
Requires the Cake.Incubator addin
IsIn<GenerationSource>(GenerationSource[]) bool
Checks if the source is contained in a list
Requires the Cake.Incubator addin
NotNull<GenerationSource>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Ftp addin
NotNull<GenerationSource>(string) void
Throws an exception if the specified parameter's value is null.
Requires the Cake.Issues addin
ThrowIfNull<GenerationSource>(string, string) T
Throws a System.ArgumentNullException with a specific message if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ThrowIfNull<GenerationSource>(string) T
Throws a System.ArgumentNullException if the value is null, otherwise returns the value
Requires the Cake.Incubator addin
ToDictionary() IDictionary<string, object>
Requires the Cake.DeployParams addin
ToStringWithNullMarkup() string
Returns the string value or a Not set> markup suitable for Spectre.Console.
Requires the Cake.Issues addin