RestApiPayload Class

RestApiPayload.

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

Initialize the RestApiPayload.

Constructor

RestApiPayload(media_type: str, properties: list[RestApiPayloadProperty], description: str | None = None, schema: str | None = None)

Parameters

Name	Description
media_type Required
properties Required
description	Default value: None
schema	Default value: None

Methods

freeze

Make the instance immutable and freeze properties.

freeze

Make the instance immutable and freeze properties.

freeze()

Attributes

description

Get the description of the payload.

media_type

Get the media type of the payload.

properties

Get the properties of the payload.

schema

Get the schema of the payload.

is_experimental

is_experimental = True

stage_status

stage_status = 'experimental'