C# Класс Swagger.ObjectModel.Builders.OperationBuilder

The operation builder.

Показать файл Открыть проект Примеры использования класса

Открытые методы

Метод	Описание
BodyParameter ( Action parameter ) : OperationBuilder	Add a body parameter for this operation
Build ( System.Operation provided = null ) : System.Operation	The build.
ConsumeMimeType ( string consume ) : OperationBuilder	Add a MIME type the operation can consume
ConsumeMimeTypes ( IEnumerable consumes ) : OperationBuilder	Add a list of MIME types the operation can consume
Description ( string description ) : OperationBuilder	A verbose explanation of the operation behavior. GitHub Flavored Markdown syntax can be used for rich text representation.
ExternalDocumentation ( ExternalDocumentation documentation ) : OperationBuilder	Additional external documentation
ExternalDocumentation ( ExternalDocumentationBuilder documentation ) : OperationBuilder	Additional external documentation
IsDeprecated ( ) : OperationBuilder	Declares this operation to be deprecated
OperationId ( string operationId ) : OperationBuilder	A friendly name for the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operation id to uniquely identify an operation.
Parameter ( Action parameter ) : OperationBuilder	Add a parameter for this operation
Parameter ( Parameter parameter ) : OperationBuilder	Add a parameter for this operation
Parameters ( IEnumerable parameters ) : OperationBuilder	Add parameters that are valid for this operation
ProduceMimeType ( string produce ) : OperationBuilder	Add a MIME type the operation can produce
ProduceMimeTypes ( IEnumerable produces ) : OperationBuilder	Add a list of MIME types the operation can produce
Response ( Action response ) : OperationBuilder	Add the default response
Response ( HttpStatusCode httpStatusCode, Action response ) : OperationBuilder	Add the expected response object for an HTTP Status Code
Response ( int httpStatusCode, Action response ) : OperationBuilder	Add the expected response object for an HTTP Status Code
Response ( string httpStatusCode, Action response ) : OperationBuilder	Add the expected response object for an HTTP Status Code
Scheme ( Schemes scheme ) : OperationBuilder	Add a transfer protocol
SecurityRequirement ( KeyValuePair security ) : OperationBuilder	Add a security requirement
SecurityRequirement ( SecurityRequirementBuilder security ) : OperationBuilder	Add a security requirement from the builder
SecurityRequirement ( SecuritySchemes securityScheme ) : OperationBuilder	Shortcut to add a security requirement that is not SecuritySchemes.Oauth2
Summary ( string summary ) : OperationBuilder	A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.
Tag ( string tag ) : OperationBuilder	Add list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
Tags ( IEnumerable tags ) : OperationBuilder	Add list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

Описание методов

BodyParameter() публичный Метод

Add a body parameter for this operation

public BodyParameter ( Action parameter ) : OperationBuilder
parameter	Action	/// The parameter. ///
Результат	OperationBuilder

Build() публичный Метод

The build.

public Build ( System.Operation provided = null ) : System.Operation
provided	System.Operation
Результат	System.Operation

ConsumeMimeType() публичный Метод

Add a MIME type the operation can consume

public ConsumeMimeType ( string consume ) : OperationBuilder
consume	string	/// The consume. ///
Результат	OperationBuilder

ConsumeMimeTypes() публичный Метод

Add a list of MIME types the operation can consume

public ConsumeMimeTypes ( IEnumerable consumes ) : OperationBuilder
consumes	IEnumerable	/// The consumes. ///
Результат	OperationBuilder

Description() публичный Метод

A verbose explanation of the operation behavior. GitHub Flavored Markdown syntax can be used for rich text representation.

public Description ( string description ) : OperationBuilder
description	string	/// The description. ///
Результат	OperationBuilder

ExternalDocumentation() публичный Метод

Additional external documentation

public ExternalDocumentation ( ExternalDocumentation documentation ) : OperationBuilder
documentation	ExternalDocumentation	/// The documentation. ///
Результат	OperationBuilder

ExternalDocumentation() публичный Метод

Additional external documentation

public ExternalDocumentation ( ExternalDocumentationBuilder documentation ) : OperationBuilder
documentation	ExternalDocumentationBuilder	/// The documentation. ///
Результат	OperationBuilder

IsDeprecated() публичный Метод

Declares this operation to be deprecated

public IsDeprecated ( ) : OperationBuilder
Результат	OperationBuilder

OperationId() публичный Метод

A friendly name for the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operation id to uniquely identify an operation.

public OperationId ( string operationId ) : OperationBuilder
operationId	string	/// The operation id. ///
Результат	OperationBuilder

Parameter() публичный Метод

Add a parameter for this operation

public Parameter ( Action parameter ) : OperationBuilder
parameter	Action	/// The parameter. ///
Результат	OperationBuilder

Parameter() публичный Метод

Add a parameter for this operation

public Parameter ( Parameter parameter ) : OperationBuilder
parameter	Parameter	/// The parameter. ///
Результат	OperationBuilder

Parameters() публичный Метод

Add parameters that are valid for this operation

public Parameters ( IEnumerable parameters ) : OperationBuilder
parameters	IEnumerable	/// The parameters. ///
Результат	OperationBuilder

ProduceMimeType() публичный Метод

Add a MIME type the operation can produce

public ProduceMimeType ( string produce ) : OperationBuilder
produce	string	/// The produce. ///
Результат	OperationBuilder

ProduceMimeTypes() публичный Метод

Add a list of MIME types the operation can produce

public ProduceMimeTypes ( IEnumerable produces ) : OperationBuilder
produces	IEnumerable	/// The produces. ///
Результат	OperationBuilder

Response() публичный Метод

Add the default response

public Response ( Action response ) : OperationBuilder
response	Action	/// The response. ///
Результат	OperationBuilder

Response() публичный Метод

Add the expected response object for an HTTP Status Code

public Response ( HttpStatusCode httpStatusCode, Action response ) : OperationBuilder
httpStatusCode	HttpStatusCode	/// The http status code. ///
response	Action	/// The response. ///
Результат	OperationBuilder

Response() публичный Метод

Add the expected response object for an HTTP Status Code

public Response ( int httpStatusCode, Action response ) : OperationBuilder
httpStatusCode	int	/// The http status code. ///
response	Action	/// The response. ///
Результат	OperationBuilder

Response() публичный Метод

Add the expected response object for an HTTP Status Code

public Response ( string httpStatusCode, Action response ) : OperationBuilder
httpStatusCode	string	/// The http status code. ///
response	Action	/// The response. ///
Результат	OperationBuilder

Scheme() публичный Метод

Add a transfer protocol

public Scheme ( Schemes scheme ) : OperationBuilder
scheme	Schemes	/// The scheme. ///
Результат	OperationBuilder

SecurityRequirement() публичный Метод

Add a security requirement

public SecurityRequirement ( KeyValuePair security ) : OperationBuilder
security	KeyValuePair	/// The security. ///
Результат	OperationBuilder

SecurityRequirement() публичный Метод

Add a security requirement from the builder

public SecurityRequirement ( SecurityRequirementBuilder security ) : OperationBuilder
security	SecurityRequirementBuilder	/// The security. ///
Результат	OperationBuilder

SecurityRequirement() публичный Метод

Shortcut to add a security requirement that is not SecuritySchemes.Oauth2

public SecurityRequirement ( SecuritySchemes securityScheme ) : OperationBuilder
securityScheme	SecuritySchemes	/// The security scheme. ///
Результат	OperationBuilder

Summary() публичный Метод

A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.

public Summary ( string summary ) : OperationBuilder
summary	string	/// The summary. ///
Результат	OperationBuilder

Tag() публичный Метод

Add list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

public Tag ( string tag ) : OperationBuilder
tag	string	/// The tag. ///
Результат	OperationBuilder

Tags() публичный Метод

Add list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.

public Tags ( IEnumerable tags ) : OperationBuilder
tags	IEnumerable	/// The tags. ///
Результат	OperationBuilder