Class EpVersion

represents an endpoint version

Inheritance
object
EpVersion
Inherited Members
Namespace: FastEndpoints
Assembly: FastEndpoints.dll
Syntax
public sealed class EpVersion

Properties

Current

Declaration
public int Current { get; }
Property Value
Type Description
int

DeprecatedAt

Declaration
public int DeprecatedAt { get; }
Property Value
Type Description
int

StartingReleaseVersion

Declaration
public int StartingReleaseVersion { get; }
Property Value
Type Description
int

Methods

DeprecateAt(int)

specify starting at which version this endpoint should be considered deprecated.

NOTE: it would be the endpoint version to deprecate at for "release group" strategy, and the "release version" of the swagger doc when using the "release version" strategy.

Declaration
public EpVersion DeprecateAt(int version)
Parameters
Type Name Description
int version
Returns
Type Description
EpVersion

StartingRelease(int)

specify the "release" number of the swagger document where this endpoint should start showing up in. for example, if a swagger doc such as the following is defined:

bld.Services.SwaggerDocument(
       o =>
       {
           o.DocumentSettings = d => d.DocumentName = "Release 2";
           o.ReleaseVersion = 2;
       })

this endpoint will only show up for the above doc and later if you do the following:

Version(n).StartingRelease(2);
Declaration
public EpVersion StartingRelease(int version)
Parameters
Type Name Description
int version

the starting release version number of the swagger doc
Returns
Type Description
EpVersion