Package org.eclipse.microprofile.openapi.models

Interface Extensible

All Known Subinterfaces:
APIResponse, Callback, Components, Contact, Encoding, Example, ExternalDocumentation, Header, Info, License, Link, MediaType, OAuthFlow, OAuthFlows, OpenAPI, Operation, Parameter, PathItem, Paths, RequestBody, Schema, Scopes, SecurityScheme, Server, ServerVariable, ServerVariables, Tag, XML
public interface Extensible
The base interface for OpenAPI model objects that can contain extensions. Extensions contain data not required by the specification and may or may not be supported by the tools you use.

The extensions property names are always prefixed by "x-".

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    addExtension(String name, Object value)
    Adds the given object to this Extensible's map of extensions, with the given name as its key.
    Map<String,Object>
    getExtensions()
    Returns the extensions property from an Extensible instance.
    void
    setExtensions(Map<String,Object> extensions)
    Sets this Extensible's extensions property to the given map of extensions.

  • Method Details

    • getExtensions

      Map<String,Object> getExtensions()
      Returns the extensions property from an Extensible instance.
      Returns:
      a map containing keys which start with "x-" and values which provide additional information

    • addExtension

      void addExtension(String name, Object value)
      Adds the given object to this Extensible's map of extensions, with the given name as its key.
      Parameters:
      name - the key used to access the extension object. Always prefixed by "x-".
      value - data not required by the specification

    • setExtensions

      void setExtensions(Map<String,Object> extensions)
      Sets this Extensible's extensions property to the given map of extensions.
      Parameters:
      extensions - map containing keys which start with "x-" and values which provide additional information