WSO2 · JSON Structure

Publisher Api Comment Structure

Comment schema from WSO2 API Manager

Type: object Properties: 10 Required: 1
API ManagementGatewaysOpen SourceAPI LifecycleGraphQLSOAPREST

Comment is a JSON Structure definition published by WSO2, describing 10 properties, of which 1 is required. It conforms to the https://json-structure.org/meta/core/v0/# meta-schema.

Properties

id content createdTime createdBy updatedTime category parentCommentId entryPoint commenterInfo replies

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-comment-structure.json",
  "name": "Comment",
  "description": "Comment schema from WSO2 API Manager",
  "required": [
    "content"
  ],
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "readOnly": true,
      "example": "943d3002-000c-42d3-a1b9-d6559f8a4d49"
    },
    "content": {
      "maxLength": 512,
      "type": "string",
      "example": "This is a comment"
    },
    "createdTime": {
      "type": "string",
      "readOnly": true,
      "example": "2021-02-11-09:57:25"
    },
    "createdBy": {
      "type": "string",
      "readOnly": true,
      "example": "admin"
    },
    "updatedTime": {
      "type": "string",
      "readOnly": true,
      "example": "2021-02-12-19:57:25"
    },
    "category": {
      "type": "string",
      "readOnly": true,
      "default": "general",
      "example": "general"
    },
    "parentCommentId": {
      "type": "string",
      "readOnly": true,
      "example": "6f38aea2-f41e-4ac9-b3f2-a9493d00ba97"
    },
    "entryPoint": {
      "type": "string",
      "readOnly": true,
      "enum": [
        "devPortal",
        "publisher"
      ]
    },
    "commenterInfo": {
      "$ref": "#/components/schemas/CommenterInfo"
    },
    "replies": {
      "$ref": "#/components/schemas/CommentList"
    }
  }
}