WSO2 · Schema

The Service Object

Service schema from WSO2 API Manager

API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Properties

Name	Type	Description
id	string
name	string
description	string
version	string
serviceKey	string
serviceUrl	string
definitionType	string	The type of the provided API definition
securityType	string	The security type of the endpoint
mutualSSLEnabled	boolean	Whether Mutual SSL is enabled for the endpoint
usage	integer	Number of usages of the service in APIs
createdTime	string
lastUpdatedTime	string
md5	string
definitionUrl	string

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/service-catalog-api-service-schema.json",
  "title": "The Service Object",
  "description": "Service schema from WSO2 API Manager",
  "type": "object",
  "required": [
    "name",
    "version",
    "definitionType",
    "serviceUrl"
  ],
  "properties": {
    "id": {
      "type": "string",
      "example": "01234567-0123-0123-0123-012345678901",
      "readOnly": true
    },
    "name": {
      "type": "string",
      "pattern": "^[^\\*]+$",
      "example": "Pizzashack-Endpoint",
      "maxLength": 255,
      "minLength": 1
    },
    "description": {
      "type": "string",
      "example": "A Catalog Entry that exposes a REST endpoint",
      "maxLength": 1024
    },
    "version": {
      "type": "string",
      "example": "v1",
      "maxLength": 30,
      "minLength": 1
    },
    "serviceKey": {
      "type": "string",
      "example": "Pizzashack-Endpoint-1.0.0",
      "maxLength": 512
    },
    "serviceUrl": {
      "type": "string",
      "example": "http://localhost/pizzashack"
    },
    "definitionType": {
      "type": "string",
      "description": "The type of the provided API definition",
      "example": "OAS3",
      "enum": [
        "OAS2",
        "OAS3",
        "WSDL1",
        "WSDL2",
        "GRAPHQL_SDL",
        "ASYNC_API"
      ]
    },
    "securityType": {
      "type": "string",
      "description": "The security type of the endpoint",
      "example": "BASIC",
      "enum": [
        "BASIC",
        "DIGEST",
        "OAUTH2",
        "X509",
        "API_KEY",
        "NONE"
      ],
      "default": "NONE"
    },
    "mutualSSLEnabled": {
      "type": "boolean",
      "description": "Whether Mutual SSL is enabled for the endpoint",
      "default": false,
      "example": false
    },
    "usage": {
      "type": "integer",
      "description": "Number of usages of the service in APIs",
      "readOnly": true,
      "example": 1
    },
    "createdTime": {
      "type": "string",
      "readOnly": true,
      "example": "2020-02-20T13:57:16.229"
    },
    "lastUpdatedTime": {
      "type": "string",
      "readOnly": true,
      "example": "2020-02-20T13:57:16.229"
    },
    "md5": {
      "type": "string",
      "example": "36583a6a249b410e7fc4f892029709cac09763ddb230e1a829d5f9134d1abd07"
    },
    "definitionUrl": {
      "type": "string",
      "example": "https://petstore.swagger.io/v2/swagger.json"
    }
  }
}