- Companion:
- class
Type members
Classlikes
Used to pass a specific cookie value to the API.
Used to pass a specific cookie value to the API.
- Value parameters:
- allowEmptyValue
Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.
- deprecated
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
- description
A brief description of the parameter.
- name
The name of the parameter. Parameter names are case sensitive.
- required
Determines whether this parameter is mandatory.
Custom headers that are expected as part of the request. Note that [RFC7230] states header names are case insensitive.
Custom headers that are expected as part of the request. Note that [RFC7230] states header names are case insensitive.
- Value parameters:
- allowEmptyValue
Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.
- deprecated
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
- description
A brief description of the parameter.
- name
The name of the parameter. Parameter names are case sensitive.
- required
Determines whether this parameter is mandatory.
Used together with Path Templating, where the parameter value is actually part of the operation’s URL. This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.
Used together with Path Templating, where the parameter value is actually part of the operation’s URL. This does not include the host or base path of the API. For example, in /items/{itemId}, the path parameter is itemId.
- Value parameters:
- allowEmptyValue
Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.
- deprecated
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
- description
A brief description of the parameter.
- name
The name of the parameter. Parameter names are case sensitive.
- required
Determines whether this parameter is mandatory.
Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.
Parameters that are appended to the URL. For example, in /items?id=###, the query parameter is id.
- Value parameters:
- allowEmptyValue
Sets the ability to pass empty-valued parameters. This is valid only for query parameters and allows sending a parameter with an empty value. If style is used, and if behavior is n/a (cannot be serialized), the value of allowEmptyValue SHALL be ignored. Use of this property is NOT RECOMMENDED, as it is likely to be removed in a later revision.
- deprecated
Specifies that a parameter is deprecated and SHOULD be transitioned out of usage.
- description
A brief description of the parameter.
- name
The name of the parameter. Parameter names are case sensitive.