WSO2 · JSON Structure

Devportal Api Search Result List Structure

SearchResultList schema from WSO2 API Manager

Type: object Properties: 3
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Search Result List is a JSON Structure definition published by WSO2, describing 3 properties. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

count list pagination

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-search-result-list-structure.json",
  "name": "Search Result List",
  "description": "SearchResultList schema from WSO2 API Manager",
  "type": "object",
  "properties": {
    "count": {
      "type": "int32",
      "description": "Number of results returned.\n",
      "example": 1
    },
    "list": {
      "type": "array",
      "items": {
        "type": "object"
      },
      "example": [
        {
          "id": "abcff4cf-24c5-4298-a7b4-39a1fbd34693",
          "name": "PizzaShackAPI",
          "type": "API",
          "transportType": null,
          "description": null,
          "context": "/pizzashack",
          "version": "1.0.0",
          "provider": "admin",
          "status": "PUBLISHED",
          "thumbnailUri": null,
          "businessInformation": {
            "businessOwner": "Jane Roe",
            "businessOwnerEmail": "businessowner@wso2.com",
            "technicalOwner": "John Doe",
            "technicalOwnerEmail": "technicalowner@wso2.com"
          },
          "avgRating": "4.0"
        }
      ]
    },
    "pagination": {
      "$ref": "#/components/schemas/Pagination"
    }
  }
}