Options
All
  • Public
  • Public/Protected
  • All
Menu
experimental

This API is experimental and might change in newer versions. Use with caution. Represenatiation of a parameter for both queries and path parameters.

Hierarchy

  • ParameterObject
    • OpenApiParameter

Index

Properties

Optional allowEmptyValue

allowEmptyValue: undefined | false | true

Optional allowReserved

allowReserved: undefined | false | true

Optional content

content: undefined | {}

Optional deprecated

deprecated: undefined | false | true

Optional description

description: undefined | string

Optional example

example: any

Optional examples

examples: undefined | {}

Optional explode

explode: undefined | false | true

in

in: string

name

name: string

Optional required

required: undefined | false | true

Optional schema

schema: ReferenceObject | SchemaObject

Optional style

style: undefined | string

type

type: string