Interface ISwaggerDocumentSpecification
Namespace: Cmc.Nexus.Common
Assembly: Cmc.Nexus.Common.Contracts.dll
Syntax
public interface ISwaggerDocumentSpecificationProperties
Description
Description of the swagger document
Declaration
string Description { get; }Property Value
| Type | Description |
|---|---|
| System.String |
DocumentUrl
name to access this document using a Url i.e. "/swagger/docs/generated/commands/{DocumentUrl}"
Declaration
string DocumentUrl { get; }Property Value
| Type | Description |
|---|---|
| System.String |
IncludeAllCommands
If true, this will include all commands in the current assembly into the swagger document
Declaration
bool IncludeAllCommands { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
IncludeCommands
if IncludeAllCommands == false, this is the list of commands to include in the swagger document
Declaration
List<Type> IncludeCommands { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.List<System.Type> |
Name
Name of the swagger document
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Version
Version of the swagger document
Declaration
string Version { get; }Property Value
| Type | Description |
|---|---|
| System.String |