Package io.smallrye.openapi.model

Class Extensions

java.lang.Object
io.smallrye.openapi.model.Extensions
public final class Extensions extends Object

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    PRIVATE_EXT_PREFIX
     

  • Method Summary

    Modifier and Type
    Method
    Description
    static boolean
    getIsRequiredSet(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)
    Returns whether RequestBody.setRequired(Boolean) has been called on a request body.
    static String
    getMethodRef(org.eclipse.microprofile.openapi.models.Operation operation)
    Implementation specific, set a reference to the Java method, so that we can bind back to it later if needed
    static String
    getName(org.eclipse.microprofile.openapi.models.Extensible<?> extensible)
     
    static String
    getParamRef(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
    Implementation specific, set a reference to the Java method parameter, so that we can bind back to it later if needed
    static <E> E
    getPrivateExtension(org.eclipse.microprofile.openapi.models.Extensible<?> extensible, String name, Class<E> type)
     
    static Set<String>
    getProfiles(org.eclipse.microprofile.openapi.models.Extensible<?> extensible)
     
    static Boolean
    getRequiredDefault(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)
     
    static String
    getResponseCode(org.eclipse.microprofile.openapi.models.responses.APIResponse response)
     
    static List<org.eclipse.microprofile.openapi.models.media.Schema>
    getTypeObservers(org.eclipse.microprofile.openapi.models.media.Schema schema)
     
    static boolean
    isHidden(org.eclipse.microprofile.openapi.models.Extensible<?> extensible)
     
    static boolean
    isPrivateExtension(String name)
     
    static void
    removeProfiles(org.eclipse.microprofile.openapi.models.Extensible<?> extensible)
     
    static void
    setHidden(org.eclipse.microprofile.openapi.models.Extensible<?> extensible, Boolean hidden)
     
    static void
    setIsRequiredSet(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody, Boolean requiredDefault)
     
    static void
    setMethodRef(org.eclipse.microprofile.openapi.models.Operation operation, org.jboss.jandex.ClassInfo resourceClass, org.jboss.jandex.MethodInfo method)
     
    static void
    setName(org.eclipse.microprofile.openapi.models.Extensible<?> extensible, String name)
     
    static void
    setParamRef(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter, org.jboss.jandex.AnnotationTarget source)
     
    static void
    setPrivateExtension(org.eclipse.microprofile.openapi.models.Extensible<?> extensible, String name, Object value)
     
    static void
    setRequiredDefault(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody, Boolean requiredDefault)
    Sets the value to use for required if RequestBody.setRequired(Boolean) has not been called.
    static void
    setResponseCode(org.eclipse.microprofile.openapi.models.responses.APIResponse response, String responseCode)
     
    static void
    setTypeObservers(org.eclipse.microprofile.openapi.models.media.Schema schema, List<org.eclipse.microprofile.openapi.models.media.Schema> observers)
     

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Method Details

    • getProfiles

      public static Set<String> getProfiles(org.eclipse.microprofile.openapi.models.Extensible<?> extensible)

    • removeProfiles

      public static void removeProfiles(org.eclipse.microprofile.openapi.models.Extensible<?> extensible)

    • getName

      public static String getName(org.eclipse.microprofile.openapi.models.Extensible<?> extensible)

    • setName

      public static void setName(org.eclipse.microprofile.openapi.models.Extensible<?> extensible, String name)

    • isHidden

      public static boolean isHidden(org.eclipse.microprofile.openapi.models.Extensible<?> extensible)

    • setHidden

      public static void setHidden(org.eclipse.microprofile.openapi.models.Extensible<?> extensible, Boolean hidden)

    • getResponseCode

      public static String getResponseCode(org.eclipse.microprofile.openapi.models.responses.APIResponse response)

    • setResponseCode

      public static void setResponseCode(org.eclipse.microprofile.openapi.models.responses.APIResponse response, String responseCode)

    • getRequiredDefault

      public static Boolean getRequiredDefault(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)

    • setRequiredDefault

      public static void setRequiredDefault(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody, Boolean requiredDefault)
      Sets the value to use for required if RequestBody.setRequired(Boolean) has not been called.

      If this method is called, RequestBody.getRequired() will return this value unless RequestBody.setRequired(Boolean) is called.

      Parameters:
      requiredDefault - the default value for required

    • getIsRequiredSet

      public static boolean getIsRequiredSet(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody)
      Returns whether RequestBody.setRequired(Boolean) has been called on a request body.
      Parameters:
      requestBody - the request body
      Returns:
      true if setRequired has been called

    • setIsRequiredSet

      public static void setIsRequiredSet(org.eclipse.microprofile.openapi.models.parameters.RequestBody requestBody, Boolean requiredDefault)

    • getParamRef

      public static String getParamRef(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter)
      Implementation specific, set a reference to the Java method parameter, so that we can bind back to it later if needed
      Returns:
      reference to the method parameter that we scanned this on

    • setParamRef

      public static void setParamRef(org.eclipse.microprofile.openapi.models.parameters.Parameter parameter, org.jboss.jandex.AnnotationTarget source)

    • getMethodRef

      public static String getMethodRef(org.eclipse.microprofile.openapi.models.Operation operation)
      Implementation specific, set a reference to the Java method, so that we can bind back to it later if needed
      Returns:
      reference to the method that we scanned this on

    • setMethodRef

      public static void setMethodRef(org.eclipse.microprofile.openapi.models.Operation operation, org.jboss.jandex.ClassInfo resourceClass, org.jboss.jandex.MethodInfo method)

    • getTypeObservers

      public static List<org.eclipse.microprofile.openapi.models.media.Schema> getTypeObservers(org.eclipse.microprofile.openapi.models.media.Schema schema)

    • setTypeObservers

      public static void setTypeObservers(org.eclipse.microprofile.openapi.models.media.Schema schema, List<org.eclipse.microprofile.openapi.models.media.Schema> observers)

    • isPrivateExtension

      public static boolean isPrivateExtension(String name)

    • getPrivateExtension

      public static <E> E getPrivateExtension(org.eclipse.microprofile.openapi.models.Extensible<?> extensible, String name, Class<E> type)

    • setPrivateExtension

      public static void setPrivateExtension(org.eclipse.microprofile.openapi.models.Extensible<?> extensible, String name, Object value)