io.github.springwolf.asyncapi.v3.model.info.Contact 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.info;

import com.fasterxml.jackson.annotation.JsonProperty;
import io.github.springwolf.asyncapi.v3.model.ExtendableObject;
import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.EqualsAndHashCode;
import lombok.NoArgsConstructor;

/**
 * Contact information for the exposed API.
 *
 * @see Contact
 */
@Data
@Builder
@NoArgsConstructor
@AllArgsConstructor
@EqualsAndHashCode(callSuper = true)
public class Contact extends ExtendableObject {

    /**
     * The identifying name of the contact person/organization.
     */
    @JsonProperty(value = "name")
    private String name;

    /**
     * The URL pointing to the contact information. MUST be in the format of a URL.
     */
    @JsonProperty(value = "url")
    private String url;

    /**
     * The email address of the contact person/organization. MUST be in the format of an email address.
     */
    @JsonProperty(value = "email")
    private String email;
}