org.springdoc.core.fn.builders.link

Class Builder

java.lang.Object

org.springdoc.core.fn.builders.link.Builder

public class Builder
extends Object

The type Link builder.

Author:

bnasslahsen

Method Summary

Modifier and Type	Method and Description
io.swagger.v3.oas.annotations.links.Link	build() Build link.
Builder	description(String description) Description link builder.
Builder	extension(Builder extensionBuilder) Extension link builder.
static Builder	linkBuilder() Builder link builder.
Builder	name(String name) Name link builder.
Builder	operationId(String operationId) Operation id link builder.
Builder	operationRef(String operationRef) Operation ref link builder.
Builder	parameter(Builder linkParameterBuilder) Parameter link builder.
Builder	ref(String ref) Ref link builder.
Builder	requestBody(String requestBody) Request body link builder.
Builder	server(Builder serverBuilder) Server link builder.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

linkBuilder

public static Builder linkBuilder()

Builder link builder.

Returns:

the link builder

name

public Builder name(String name)

Name link builder.

Parameters:

name - the name

Returns:

the link builder

operationRef

public Builder operationRef(String operationRef)

Operation ref link builder.

Parameters:

operationRef - the operation ref

Returns:

the link builder

operationId

public Builder operationId(String operationId)

Operation id link builder.

Parameters:

operationId - the operation id

Returns:

the link builder

parameter

public Builder parameter(Builder linkParameterBuilder)

Parameter link builder.

Parameters:

linkParameterBuilder - the link parameter builder

Returns:

the link builder

description

public Builder description(String description)

Description link builder.

Parameters:

description - the description

Returns:

the link builder

requestBody

public Builder requestBody(String requestBody)

Request body link builder.

Parameters:

requestBody - the request body

Returns:

the link builder

server

public Builder server(Builder serverBuilder)

Server link builder.

Parameters:

serverBuilder - the server builder

Returns:

the link builder

extension

public Builder extension(Builder extensionBuilder)

Extension link builder.

Parameters:

extensionBuilder - the extension builder

Returns:

the link builder

ref

public Builder ref(String ref)

Ref link builder.

Parameters:

ref - the ref

Returns:

the link builder

build

public io.swagger.v3.oas.annotations.links.Link build()

Build link.

Returns:

the link