org.eclipse.microprofile.openapi.annotations.media.DependentSchema Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of microprofile-openapi-api Show documentation

MicroProfile OpenAPI API :: API

There is a newer version: 4.0.2

Show newest version

/*
 * Copyright (c) 2024 Contributors to the Eclipse Foundation
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 

 * http://www.apache.org/licenses/LICENSE-2.0
 * 

 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.eclipse.microprofile.openapi.annotations.media;

/**
 * A property name and an associated schema.
 * 
 * Used with {@link Schema#dependentSchemas()}, if an instance has a property named {@link #name()}, then it must
 * validate against {@link #schema()}.
 *
 * @see Schema#dependentSchemas()
 * @since 4.0
 */
public @interface DependentSchema {

    /**
     * A property name
     *
     * @return property name
     */
    String name();

    /**
     * The schema that an instance must validate against if it has a property named {@link #name()}.
     *
     * @return a class used to generate a schema which is used to validate objects with properties named {@link #name()}
     */
    Class schema();
}