WSO2 · JSON Structure

Publisher Api Api Product Info Structure

APIProductInfo schema from WSO2 API Manager

Type: object Properties: 20
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

API Info object with basic API details. is a JSON Structure definition published by WSO2, describing 20 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id name displayName context description provider version hasThumbnail state securityScheme createdTime updatedTime gatewayVendor audiences monetizedInfo businessOwner businessOwnerEmail TechnicalOwner TechnicalOwnerEmail egress

Meta-schema: https://json-structure.org/meta/core/v0/#

JSON Structure

Raw ↑
{
  "$schema": "https://json-structure.org/meta/core/v0/#",
  "$id": "https://raw.githubusercontent.com/api-evangelist/wso2/refs/heads/main/json-structure/publisher-api-api-product-info-structure.json",
  "name": "API Info object with basic API details.",
  "description": "APIProductInfo schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "UUID of the api product\n",
      "readOnly": true,
      "example": "01234567-0123-0123-0123-012345678901"
    },
    "name": {
      "type": "string",
      "description": "Name of the API Product",
      "example": "PizzaShackAPIProduct"
    },
    "displayName": {
      "type": "string",
      "example": "Calculator Product API",
      "description": "Display name of the API Product.\nThis is the name that will be displayed in the Publisher and DevPortal.\nIf not provided, the name will be used as the display name.\n"
    },
    "context": {
      "type": "string",
      "example": "pizzaproduct"
    },
    "description": {
      "type": "string",
      "description": "A brief description about the API",
      "example": "This is a simple API for Pizza Shack online pizza delivery store"
    },
    "provider": {
      "type": "string",
      "description": "If the provider value is not given, the user invoking the API will be used as the provider.\n",
      "example": "admin"
    },
    "version": {
      "type": "string",
      "example": "1.0.0"
    },
    "hasThumbnail": {
      "type": "boolean",
      "example": true
    },
    "state": {
      "type": "string",
      "description": "State of the API product. Only published API products are visible on the Developer Portal\n"
    },
    "securityScheme": {
      "type": "array",
      "description": "Types of API security, the current API secured with. It can be either OAuth2 or mutual SSL or both. If\nit is not set OAuth2 will be set as the security for the current API.\n",
      "example": [
        "oauth2"
      ],
      "items": {
        "type": "string"
      }
    },
    "createdTime": {
      "type": "string",
      "description": "Created time as unix timestamp in milliseconds.",
      "example": 1756199448644
    },
    "updatedTime": {
      "type": "string",
      "description": "Update time as unix timestamp in milliseconds.",
      "example": 1756199448644
    },
    "gatewayVendor": {
      "type": "string",
      "example": "wso2"
    },
    "audiences": {
      "type": "array",
      "description": "The audiences of the API product for jwt validation. Accepted values are any String values",
      "items": {
        "type": "string",
        "example": [
          "aud1",
          "aud2",
          "aud3"
        ]
      }
    },
    "monetizedInfo": {
      "type": "boolean",
      "example": true
    },
    "businessOwner": {
      "type": "string",
      "example": "Business Owner"
    },
    "businessOwnerEmail": {
      "type": "string",
      "example": "businessowner@abc.com"
    },
    "TechnicalOwner": {
      "type": "string",
      "example": "Technical Owner"
    },
    "TechnicalOwnerEmail": {
      "type": "string",
      "example": "technicalowner@abc.com"
    },
    "egress": {
      "type": "boolean",
      "description": "Whether the APIProduct is EGRESS or not",
      "default": false,
      "example": true
    }
  }
}