Package org.apache.juneau.bean.openapi3

Class Parameter

java.lang.Object
org.apache.juneau.bean.openapi3.OpenApiElement
org.apache.juneau.bean.openapi3.Parameter
public class Parameter extends OpenApiElement
Describes a single operation parameter.

The Parameter Object describes a single parameter used in an API operation. Parameters can be passed in various locations including the path, query string, headers, or cookies. Each parameter has a name, location, and schema that defines its type and constraints.

OpenAPI Specification:

The Parameter Object is composed of the following fields:

  • name (string, REQUIRED) - The name of the parameter
  • in (string, REQUIRED) - The location of the parameter. Possible values: "query", "header", "path", or "cookie"
  • description (string) - A brief description of the parameter (CommonMark syntax may be used)
  • required (boolean) - Determines whether this parameter is mandatory (must be true if in is "path")
  • deprecated (boolean) - Specifies that a parameter is deprecated
  • allowEmptyValue (boolean) - Sets the ability to pass empty-valued parameters (valid only for "query" parameters)
  • style (string) - Describes how the parameter value will be serialized
  • explode (boolean) - When true, parameter values of type array or object generate separate parameters for each value
  • allowReserved (boolean) - Determines whether the parameter value should allow reserved characters
  • schema (SchemaInfo) - The schema defining the type used for the parameter
  • example (any) - Example of the parameter's potential value
  • examples (map of Example) - Examples of the parameter's potential value
Example:

// Create a query parameter Parameter param = new Parameter() .setName("status") .setIn("query") .setDescription("Status values to filter by") .setRequired(false) .setSchema( new SchemaInfo() .setType("array") .setItems( new Items().setType("string") ) ) .setStyle("form") .setExplode(true);

See Also:

  • Constructor Details

    • Parameter

      public Parameter()
      Default constructor.

    • Parameter

      public Parameter(Parameter copyFrom)
      Copy constructor.
      Parameters:
      copyFrom - The object to copy.

  • Method Details

    • copy

      public Parameter copy()
      Makes a copy of this object.
      Returns:
      A new copy of this object.

    • get

      public <T> T get(String property, Class<T> type)
      Description copied from class: OpenApiElement
      Generic property getter.

      Can be used to retrieve non-standard Swagger fields such as "$ref".

      Overrides:
      get in class OpenApiElement
      Type Parameters:
      T - The datatype to cast the value to.
      Parameters:
      property - The property name to retrieve.
      type - The datatype to cast the value to.
      Returns:
      The property value, or null if the property does not exist or is not set.

    • getAllowEmptyValue

      public Boolean getAllowEmptyValue()
      Returns the allow empty value flag.
      Returns:
      The allow empty value flag.

    • getAllowReserved

      public Boolean getAllowReserved()
      Returns the allow reserved flag.
      Returns:
      The allow reserved flag.

    • getDeprecated

      public Boolean getDeprecated()
      Returns the deprecated flag.
      Returns:
      The deprecated flag.

    • getDescription

      public String getDescription()
      Returns the description.
      Returns:
      The description.

    • getExample

      public Object getExample()
      Returns the example.
      Returns:
      The example.

    • getExamples

      public Map<String,Example> getExamples()
      Returns the examples map.
      Returns:
      The examples map.

    • getExplode

      public Boolean getExplode()
      Returns the explode flag.
      Returns:
      The explode flag.

    • getIn

      public String getIn()
      Returns the parameter location.
      Returns:
      The parameter location.

    • getName

      public String getName()
      Returns the parameter name.
      Returns:
      The parameter name.

    • getRequired

      public Boolean getRequired()
      Returns the required flag.
      Returns:
      The required flag.

    • getSchema

      public SchemaInfo getSchema()
      Returns the schema.
      Returns:
      The schema.

    • getStyle

      public String getStyle()
      Returns the style.
      Returns:
      The style.

    • keySet

      public Set<String> keySet()
      Description copied from class: OpenApiElement
      Returns all the keys on this element.
      Overrides:
      keySet in class OpenApiElement
      Returns:
      All the keys on this element.
      Never null.

    • set

      public Parameter set(String property, Object value)
      Description copied from class: OpenApiElement
      Generic property setter.

      Can be used to set non-standard Swagger fields such as "$ref".

      Overrides:
      set in class OpenApiElement
      Parameters:
      property - The property name to set. Must not be null.
      value - The new value for the property.
      Returns:
      This object

    • setAllowEmptyValue

      public Parameter setAllowEmptyValue(Boolean value)
      Sets the allow empty value flag.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • setAllowReserved

      public Parameter setAllowReserved(Boolean value)
      Sets the allow reserved flag.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • setDeprecated

      public Parameter setDeprecated(Boolean value)
      Sets the deprecated flag.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • setDescription

      public Parameter setDescription(String value)
      Sets the description.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • setExample

      public Parameter setExample(Object value)
      Sets the example.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • setExamples

      public Parameter setExamples(Map<String,Example> value)
      Sets the examples map.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • setExplode

      public Parameter setExplode(Boolean value)
      Sets the explode flag.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • setIn

      public Parameter setIn(String value)
      Sets the parameter location.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • setName

      public Parameter setName(String value)
      Sets the parameter name.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • setRequired

      public Parameter setRequired(Boolean value)
      Sets the required flag.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • setSchema

      public Parameter setSchema(SchemaInfo value)
      Sets the schema.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • setStyle

      public Parameter setStyle(String value)
      Sets the style.
      Parameters:
      value - The new value for this property.
      Returns:
      This object.

    • strict

      public Parameter strict()
      Description copied from class: OpenApiElement
      Sets strict mode on this bean.
      Overrides:
      strict in class OpenApiElement
      Returns:
      This object

    • strict

      public Parameter strict(Object value)
      Description copied from class: OpenApiElement
      Sets strict mode on this bean.
      Overrides:
      strict in class OpenApiElement
      Parameters:
      value - The new value for this property.
      Non-boolean values will be converted to boolean using Boolean.valueOf(value.toString()).
      Can be null (interpreted as false).
      Returns:
      This object