WSO2 · Schema

Operation

APIOperations schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name	Type	Description
id	string
target	string
verb	string
authType	string
throttlingPolicy	string
scopes	array
usedProductIds	array
amznResourceName	string
amznResourceTimeout	integer
amznResourceContentEncode	boolean
payloadSchema	string
uriMapping	string
operationPolicies	object
operationHubPolicies	array	Policy Hub policies at resource/operation level (sibling to operationPolicies).

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-schema/publisher-api-api-operations-schema.json",
  "title": "Operation",
  "description": "APIOperations schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "example": "postapiresource"
    },
    "target": {
      "type": "string",
      "example": "/order/{orderId}"
    },
    "verb": {
      "type": "string",
      "example": "POST"
    },
    "authType": {
      "type": "string",
      "example": "Application & Application User",
      "default": "Any"
    },
    "throttlingPolicy": {
      "type": "string",
      "example": "Unlimited"
    },
    "scopes": {
      "type": "array",
      "example": [],
      "items": {
        "type": "string"
      }
    },
    "usedProductIds": {
      "type": "array",
      "example": [],
      "items": {
        "type": "string"
      }
    },
    "amznResourceName": {
      "type": "string",
      "example": ""
    },
    "amznResourceTimeout": {
      "type": "integer"
    },
    "amznResourceContentEncode": {
      "type": "boolean"
    },
    "payloadSchema": {
      "type": "string",
      "example": ""
    },
    "uriMapping": {
      "type": "string",
      "example": ""
    },
    "operationPolicies": {
      "$ref": "#/components/schemas/APIOperationPolicies"
    },
    "operationHubPolicies": {
      "type": "array",
      "description": "Policy Hub policies at resource/operation level (sibling to operationPolicies).",
      "items": {
        "$ref": "#/components/schemas/OperationPolicy"
      }
    }
  }
}