ApiOperationPropertiesDefinition

The api operations properties

AzureIntegrationiPaaSWorkflows

Properties

Name	Type	Description
annotation	object	The annotation of api operation.
api	object	The api reference.
description	string	The description of the api operation.
inputsDefinition	object	The operation inputs definition schema.
isNotification	boolean	Indicates whether the API operation is notification or not.
isWebhook	boolean	Indicates whether the API operation is webhook or not.
pageable	boolean	Indicates whether the api operation is pageable.
responsesDefinition	object	The operation responses definition schemas.
summary	string	The summary of the api operation.
trigger	string	The trigger type of api operation.
triggerHint	string	The trigger hint for the api operation.
visibility	string	The visibility of the api operation.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/azure-logic-apps/refs/heads/main/json-schema/azure-logic-apps-api-operation-properties-definition-schema.json",
  "title": "ApiOperationPropertiesDefinition",
  "description": "The api operations properties",
  "type": "object",
  "properties": {
    "annotation": {
      "$ref": "#/definitions/ApiOperationAnnotation",
      "description": "The annotation of api operation."
    },
    "api": {
      "$ref": "#/definitions/ApiReference",
      "description": "The api reference."
    },
    "description": {
      "description": "The description of the api operation.",
      "type": "string"
    },
    "inputsDefinition": {
      "$ref": "#/definitions/SwaggerSchema",
      "description": "The operation inputs definition schema."
    },
    "isNotification": {
      "description": "Indicates whether the API operation is notification or not.",
      "type": "boolean"
    },
    "isWebhook": {
      "description": "Indicates whether the API operation is webhook or not.",
      "type": "boolean"
    },
    "pageable": {
      "description": "Indicates whether the api operation is pageable.",
      "type": "boolean"
    },
    "responsesDefinition": {
      "additionalProperties": {
        "$ref": "#/definitions/SwaggerSchema"
      },
      "description": "The operation responses definition schemas.",
      "type": "object"
    },
    "summary": {
      "description": "The summary of the api operation.",
      "type": "string"
    },
    "trigger": {
      "description": "The trigger type of api operation.",
      "type": "string"
    },
    "triggerHint": {
      "description": "The trigger hint for the api operation.",
      "type": "string"
    },
    "visibility": {
      "description": "The visibility of the api operation.",
      "type": "string"
    }
  }
}