io.github.springwolf.asyncapi.v3.model.ExternalDocumentation Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of springwolf-asyncapi Show documentation

Springwolf implementation of the AsyncApi specification

There is a newer version: 1.9.0

// SPDX-License-Identifier: Apache-2.0
package io.github.springwolf.asyncapi.v3.model;

import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonProperty;
import jakarta.validation.constraints.NotNull;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;

/**
 * Allows referencing an external resource for extended documentation.
 *
 * @see ExternalDocumentation
 */
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = true)
public class ExternalDocumentation extends ExtendableObject implements Reference {

    /**
     * A short description of the target documentation. CommonMark syntax
     * can be used for rich text representation.
     */
    @JsonProperty(value = "description")
    private String description;

    /**
     * Required.
     * 
     * The URL for the target documentation. Value MUST be in the format of a URL.
     */
    @NotNull
    @JsonProperty(value = "url")
    private String url;

    @JsonIgnore
    private String ref;

    @Override
    public String getRef() {
        return ref;
    }
}