Skip to main content

OpenApiDeclaration

Assembly: ServiceStack.Api.OpenApi.dll​
View Source​
Declaration
[DataContract]
[ExcludeMetadata]
public class OpenApiDeclaration

Properties​

Swagger​

View Source​
Declaration
[DataMember(Name = "swagger")]
public string Swagger { get; }

Info​

View Source​
Declaration
[DataMember(Name = "info")]
public OpenApiInfo Info { get; set; }

Host​

View Source​
Declaration
[DataMember(Name = "host")]
public string Host { get; set; }

BasePath​

View Source​
Declaration
[DataMember(Name = "basePath")]
public string BasePath { get; set; }

Schemes​

View Source​
Declaration
[DataMember(Name = "schemes")]
public List<string> Schemes { get; set; }

Consumes​

View Source​
Declaration
[DataMember(Name = "consumes")]
public List<string> Consumes { get; set; }

Produces​

View Source​
Declaration
[DataMember(Name = "produces")]
public List<string> Produces { get; set; }

Paths​

View Source​
Declaration
[DataMember(Name = "paths")]
public OrderedDictionary<string, OpenApiPath> Paths { get; set; }

Definitions​

View Source​
Declaration
[DataMember(Name = "definitions")]
public Dictionary<string, OpenApiSchema> Definitions { get; set; }

Parameters​

View Source​
Declaration
[DataMember(Name = "parameters")]
public Dictionary<string, OpenApiParameter> Parameters { get; set; }

Responses​

View Source​
Declaration
[DataMember(Name = "responses")]
public OrderedDictionary<string, OpenApiResponse> Responses { get; set; }

SecurityDefinitions​

View Source​
Declaration
[DataMember(Name = "securityDefinitions")]
public Dictionary<string, OpenApiSecuritySchema> SecurityDefinitions { get; set; }

Security​

View Source​
Declaration
[DataMember(Name = "security")]
public List<Dictionary<string, List<string>>> Security { get; set; }

Tags​

View Source​
Declaration
[DataMember(Name = "tags")]
public List<OpenApiTag> Tags { get; set; }

ExternalDocs​

View Source​
Declaration
[DataMember(Name = "externalDocs")]
public OpenApiExternalDocumentation ExternalDocs { get; set; }