RestApiParameter Class

RestApiParameter.

Note: This class is marked as 'experimental' and may change in the future.

Initialize the RestApiParameter.

Constructor

RestApiParameter(name: str, type: str, location: RestApiParameterLocation, style: RestApiParameterStyle | None = None, alternative_name: str | None = None, description: str | None = None, is_required: bool = False, default_value: Any | None = None, schema: str | dict | None = None, response: RestApiExpectedResponse | None = None)

Parameters

Name	Description
name Required
type Required
location Required
style	Default value: None
alternative_name	Default value: None
description	Default value: None
is_required	Default value: False
default_value	Default value: None
schema	Default value: None
response	Default value: None

Methods

freeze

Make the instance immutable.

freeze

Make the instance immutable.

freeze()

Attributes

alternative_name

Get the alternative name of the parameter.

default_value

Get the default value of the parameter.

description

Get the description of the parameter.

is_required

Get whether the parameter is required.

location

Get the location of the parameter.

name

Get the name of the parameter.

response

Get the response of the parameter.

schema

Get the schema of the parameter.

style

Get the style of the parameter.

type

Get the type of the parameter.

is_experimental

is_experimental = True

stage_status

stage_status = 'experimental'