Class OpenApi

java.lang.Object

io.helidon.openapi.OpenApi

public final class OpenApi
extends Object

OpenAPI document annotations.

Declarative OpenAPI annotations do not model operation callbacks or OpenAPI 3.1 and 3.2 top-level webhooks. To describe a callback, use a static OpenAPI document or an OpenApiDocumentSource that defines the complete containing operation, and configure Helidon not to generate the same path and method from annotations. A static document or document source can also define top-level webhooks. Combining static and generated content uses MERGE mode and requires non-conflicting content.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static @interface	OpenApi.ApiKeySecurityScheme	OpenAPI API Key Security Scheme Object metadata.
static @interface	OpenApi.ApiKeySecuritySchemes	Container for repeated OpenApi.ApiKeySecurityScheme.
static @interface	OpenApi.Contact	OpenAPI Contact Object metadata.
static @interface	OpenApi.Content	OpenAPI Media Type Object metadata.
static @interface	OpenApi.Document	Marker for a type that contributes document-level OpenAPI metadata.
static @interface	OpenApi.Endpoint	Explicitly enables generated OpenAPI data for a declarative REST endpoint.
static @interface	OpenApi.Example	OpenAPI Example Object metadata.
static enum	OpenApi.Explode	Parameter explode override.
static @interface	OpenApi.Extension	OpenAPI Specification Extension metadata.
static @interface	OpenApi.Extensions	Container for repeated OpenApi.Extension.
static @interface	OpenApi.ExternalDocs	OpenAPI External Documentation Object metadata.
static @interface	OpenApi.Header	OpenAPI Header Object metadata.
static @interface	OpenApi.Hidden	Excludes an endpoint type or operation method from generated OpenAPI output.
static @interface	OpenApi.HttpSecurityScheme	OpenAPI HTTP Security Scheme Object metadata.
static @interface	OpenApi.HttpSecuritySchemes	Container for repeated OpenApi.HttpSecurityScheme.
static @interface	OpenApi.Info	OpenAPI Info Object metadata.
static @interface	OpenApi.License	OpenAPI License Object metadata.
static @interface	OpenApi.Link	OpenAPI Link Object metadata.
static @interface	OpenApi.LinkParameter	OpenAPI Link Object parameter metadata.
static @interface	OpenApi.MutualTlsSecurityScheme	OpenAPI Mutual TLS Security Scheme Object metadata.
static @interface	OpenApi.MutualTlsSecuritySchemes	Container for repeated OpenApi.MutualTlsSecurityScheme.
static @interface	OpenApi.OAuth2SecurityScheme	OpenAPI OAuth 2 Security Scheme Object metadata.
static @interface	OpenApi.OAuth2SecuritySchemes	Container for repeated OpenApi.OAuth2SecurityScheme.
static @interface	OpenApi.OAuthFlow	OpenAPI OAuth Flow Object metadata.
static @interface	OpenApi.OAuthFlows	OpenAPI OAuth Flows Object metadata.
static @interface	OpenApi.OAuthScope	OpenAPI OAuth scope metadata.
static @interface	OpenApi.OidcSecurityScheme	OpenAPI OIDC Security Scheme Object metadata.
static @interface	OpenApi.OidcSecuritySchemes	Container for repeated OpenApi.OidcSecurityScheme.
static @interface	OpenApi.Operation	OpenAPI Operation Object metadata.
static @interface	OpenApi.Parameter	OpenAPI Parameter Object metadata.
static @interface	OpenApi.Parameters	Container for repeated OpenApi.Parameter.
static @interface	OpenApi.RequestBody	OpenAPI Request Body Object metadata.
static enum	OpenApi.Required	Requiredness override.
static @interface	OpenApi.Response	OpenAPI Response Object metadata.
static @interface	OpenApi.Responses	Container for repeated OpenApi.Response.
static @interface	OpenApi.SecurityRequirement	OpenAPI Security Requirement Object metadata.
static @interface	OpenApi.SecurityRequirements	Container for repeated OpenApi.SecurityRequirement.
static @interface	OpenApi.SecurityScheme	OpenAPI Security Scheme Object metadata.
static @interface	OpenApi.SecuritySchemeRequirement	OpenAPI Security Requirement Object scheme entry metadata.
static @interface	OpenApi.SecuritySchemes	Container for repeated OpenApi.SecurityScheme.
static @interface	OpenApi.Server	OpenAPI Server Object metadata.
static @interface	OpenApi.Servers	Container for repeated OpenApi.Server.
static @interface	OpenApi.ServerVariable	OpenAPI Server Variable Object metadata.
static enum	OpenApi.Style	Parameter serialization style.
static @interface	OpenApi.Tag	OpenAPI Tag Object metadata.
static @interface	OpenApi.Tags	Container for repeated OpenApi.Tag.

Method Summary

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait