ExternalDocumentationObjectBuilder (mu-server 0.72.20 API)

java.lang.Object
- io.muserver.openapi.ExternalDocumentationObjectBuilder

public class ExternalDocumentationObjectBuilder
extends java.lang.Object

Allows referencing an external resource for extended documentation.

Constructor Summary

Constructors
Constructor Description

ExternalDocumentationObjectBuilder()

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`ExternalDocumentationObject`	`build()`
`static ExternalDocumentationObjectBuilder`	`externalDocumentationObject()`	Creates a builder for an `ExternalDocumentationObject`
`ExternalDocumentationObjectBuilder`	`withDescription(java.lang.String description)`
`ExternalDocumentationObjectBuilder`	`withUrl(java.net.URI url)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ExternalDocumentationObjectBuilder
```
public ExternalDocumentationObjectBuilder()
```
- Method Detail
  - withDescription
```
public ExternalDocumentationObjectBuilder withDescription(java.lang.String description)
```
    Parameters:
    
    description - A short description of the target documentation. CommonMark syntax MAY be used for rich text representation.
    
    Returns:
    
    The current builder
  - withUrl
```
public ExternalDocumentationObjectBuilder withUrl(java.net.URI url)
```
    Parameters:
    
    url - REQUIRED. The URL for the target documentation.
    
    Returns:
    
    The current builder
  - build
```
public ExternalDocumentationObject build()
```
    Returns:
    
    A new object
  - externalDocumentationObject
```
public static ExternalDocumentationObjectBuilder externalDocumentationObject()
```
    Creates a builder for an ExternalDocumentationObject
    
    Returns:
    
    A new builder