Package com.asyncapi.schemas.openapi.v3._0_0.properties

Class ExternalDocumentation

java.lang.Object

com.asyncapi.schemas.openapi.v3._0_0.properties.Extensions

com.asyncapi.schemas.openapi.v3._0_0.properties.ExternalDocumentation

public class ExternalDocumentation
extends Extensions

Allows referencing an external resource for extended documentation.

Version:

3.0.0

Author:

Pavel Bodiachevskii

See Also:

• Schema Object
• ExternalDocumentation

Field Summary

Fields

Modifier and Type	Field	Description
@Nullable String	description	A short description of the target documentation.
@NotNull String	url	REQUIRED.

Fields inherited from class com.asyncapi.schemas.openapi.v3._0_0.properties.Extensions

extensions

Constructor Summary

Constructors

Constructor	Description
ExternalDocumentation()

Method Summary

Methods inherited from class com.asyncapi.schemas.openapi.v3._0_0.properties.Extensions

readExtensionProperty

Methods inherited from class java.lang.Object

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

Field Details

description

@Nullable
@JsonPropertyDescription("A short description of the target documentation.")
public @Nullable String description

A short description of the target documentation.

CommonMark syntax MAY be used for rich text representation.

url

@NotNull
@JsonPropertyDescription("The URL for the target documentation.")
public @NotNull String url

REQUIRED.

The URL for the target documentation. Value MUST be in the format of a URL.

Constructor Details

ExternalDocumentation

public ExternalDocumentation()