io.github.springwolf.asyncapi.v3.model.Reference 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.JsonProperty;
import jakarta.validation.constraints.NotNull;

/**
 * A simple object to allow referencing other components in the specification, internally and externally.
 * 
 * The Reference Object is defined by JSON Reference and follows the same structure, behavior and rules.
 * A JSON Reference SHALL only be used to refer to a schema that is formatted in either JSON or YAML. In the case of
 * a YAML-formatted Schema, the JSON Reference SHALL be applied to the JSON representation of that schema. The JSON
 * representation SHALL be made by applying the conversion described here.
 * 
 * For this specification, reference resolution is done as defined by the JSON Reference specification and not by
 * the JSON Schema specification.
 *
 * @see Reference
 */
public interface Reference {
    /**
     * Required. The reference string.
     */
    @NotNull
    @JsonProperty(value = "$ref")
    String getRef();
}