ApiOperationPropertiesDefinition Class

The api operations properties.

Constructor

ApiOperationPropertiesDefinition(*, summary: str | None = None, description: str | None = None, visibility: str | None = None, trigger: str | None = None, trigger_hint: str | None = None, pageable: bool | None = None, annotation: ApiOperationAnnotation | None = None, api: ApiReference | None = None, inputs_definition: SwaggerSchema | None = None, responses_definition: Dict[str, SwaggerSchema] | None = None, is_webhook: bool | None = None, is_notification: bool | None = None, **kwargs)

Keyword-Only Parameters

Name	Description
summary	str The summary of the api operation. Default value: None
description	str The description of the api operation. Default value: None
visibility	str The visibility of the api operation. Default value: None
trigger	str The trigger type of api operation. Default value: None
trigger_hint	str The trigger hint for the api operation. Default value: None
pageable	bool Indicates whether the api operation is pageable. Default value: None
annotation	ApiOperationAnnotation The annotation of api operation. Default value: None
api	ApiReference The api reference. Default value: None
inputs_definition	SwaggerSchema The operation inputs definition schema. Default value: None
responses_definition	dict[str, SwaggerSchema] The operation responses definition schemas. Default value: None
is_webhook	bool Indicates whether the API operation is webhook or not. Default value: None
is_notification	bool Indicates whether the API operation is notification or not. Default value: None

Variables

Name	Description
summary	str The summary of the api operation.
description	str The description of the api operation.
visibility	str The visibility of the api operation.
trigger	str The trigger type of api operation.
trigger_hint	str The trigger hint for the api operation.
pageable	bool Indicates whether the api operation is pageable.
annotation	ApiOperationAnnotation The annotation of api operation.
api	ApiReference The api reference.
inputs_definition	SwaggerSchema The operation inputs definition schema.
responses_definition	dict[str, SwaggerSchema] The operation responses definition schemas.
is_webhook	bool Indicates whether the API operation is webhook or not.
is_notification	bool Indicates whether the API operation is notification or not.