@Target(value={TYPE,PACKAGE}) @Retention(value=RUNTIME) @Inherited public @interface OpenAPIDefinition
This is the root document object of the OpenAPI document. It contains required and optional fields.
Modifier and Type | Required Element and Description |
---|---|
Info |
info
Required: Provides metadata about the API.
|
Modifier and Type | Optional Element and Description |
---|---|
Components |
components
An element to hold a set of reusable objects for different aspects of the OpenAPI Specification (OAS).
|
ExternalDocumentation |
externalDocs
Any additional external documentation for the API
|
SecurityRequirement[] |
security
A declaration of which security mechanisms can be used across the API.
|
Server[] |
servers
An array of Server Objects, which provide connectivity information to a target server.
|
Tag[] |
tags
A list of tags used by the specification with additional metadata.
|
public abstract Info info
public abstract Tag[] tags
public abstract Server[] servers
public abstract SecurityRequirement[] security
public abstract ExternalDocumentation externalDocs
public abstract Components components
Copyright © 2017 – 2020 Eclipse Foundation. All rights reserved.
Use is subject to license terms.