Class ServiceApiInfo
Human readable metadata for a service API. This maps pretty closely
to the Microsoft.OpenApi.Models.OpenApiInfo class which is used
to by Swagger when generating ASP.NET documentation.
note
We're not referencing the Microsoft.OpenApi nuget package to avoid adding about 166KB to applications using the Neon.Common assembly.f
Namespace: Neon.Service
Assembly: Neon.Common.dll
Syntax
public class ServiceApiInfoProperties
Contact
API contact information.
Declaration
public ServiceApiContact Contact { get; set; }Property Value
| Type | Description |
|---|---|
| ServiceApiContact |
Description
More detailed API description.
Declaration
public string Description { get; set; }Property Value
| Type | Description |
|---|---|
| string |
License
API licence information.
Declaration
public ServiceApiLicense License { get; set; }Property Value
| Type | Description |
|---|---|
| ServiceApiLicense |
TermsOfService
References the API terms of service.
Declaration
public Uri TermsOfService { get; set; }Property Value
| Type | Description |
|---|---|
| Uri |
Title
API documentation title.
Declaration
public string Title { get; set; }Property Value
| Type | Description |
|---|---|
| string |
Version
API version.
Declaration
public string Version { get; set; }Property Value
| Type | Description |
|---|---|
| string |