Class RequestExample

represents a swagger example request analogous to an OpenApiExample

Inheritance

object

RequestExample

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: FastEndpoints

Assembly: FastEndpoints.dll

Syntax

public sealed class RequestExample

Constructors

RequestExample(object, string, string?, string?)

represents a swagger example request analogous to an OpenApiExample

Declaration

public RequestExample(object value, string label = "Example", string? summary = null, string? description = null)

Parameters

Type	Name	Description
object	value	the actual example request object
string	label	the label/name for this example request
string	summary	the summary text of this example request
string	description	the description of this example request

Properties

Description

the description of this example request

Declaration

public string? Description { get; init; }

Property Value

Type	Description
string

Label

the label/name for this example request

Declaration

public string Label { get; }

Property Value

Type	Description
string

Summary

the summary text of this example request

Declaration

public string? Summary { get; init; }

Property Value

Type	Description
string

Value

the actual example request object

Declaration

public object Value { get; init; }

Property Value

Type	Description
object