WSO2 · JSON Structure

Devportal Api Advertise Info Structure

AdvertiseInfo schema from WSO2 API Manager

Type: object Properties: 6
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

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

Properties

advertised apiExternalProductionEndpoint apiExternalSandboxEndpoint originalDevPortalUrl apiOwner vendor

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/devportal-api-advertise-info-structure.json",
  "name": "API Advertise info object with advertise details",
  "description": "AdvertiseInfo schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "advertised": {
      "type": "boolean",
      "example": true
    },
    "apiExternalProductionEndpoint": {
      "type": "string",
      "example": "https://localhost:9443/devportal"
    },
    "apiExternalSandboxEndpoint": {
      "type": "string",
      "example": "https://localhost:9443/devportal"
    },
    "originalDevPortalUrl": {
      "type": "string",
      "example": "https://localhost:9443/devportal"
    },
    "apiOwner": {
      "type": "string",
      "example": "admin"
    },
    "vendor": {
      "type": "string",
      "default": "WSO2",
      "enum": [
        "WSO2",
        "AWS"
      ]
    }
  }
}