org.eclipse.microprofile.openapi.models.headers.package-info 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) 2017 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.
 */

/**
 * An interface of a programmable model to represent a single 
 * header object.
 * 

 * The behaviour of methods inherited from java.lang.Object are undefined by the MicroProfile OpenAPI specification.
 * 

 * Example usage:
 * 
 * .components(OASFactory.createObject(Components.class)
 *  .headers(new HashMap<String, Header>())
 *          .addHeader("Max-Rate", OASFactory.createObject(Header.class)
 *              .description("Maximum rate")
 *              .schema(OASFactory.createObject(Schema.class)
 *                  .type(Schema.SchemaType.INTEGER))
 *              .required(true)
 *              .allowEmptyValue(true)
 *              .deprecated(true))
 *          .addHeader("Request-Limit", OASFactory.createObject(Header.class)
 *              .description("The number of allowed requests in the current period")
 *              .schema(OASFactory.createObject(Schema.class)
 *                  .type(Schema.SchemaType.INTEGER)))
 * 
 */

@org.osgi.annotation.versioning.Version("1.0")
package org.eclipse.microprofile.openapi.models.headers;