APIs.io Engineering Platform · Schema
Comment Payload Object
Information about the comment.
APIs.ioEngineeringPlatform
Properties
| Name | Type | Description |
|---|---|---|
| body | string | The contents of the comment. |
| tags | object | Information about users tagged in the `body` comment. |
JSON Schema
{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/commentCreateUpdate",
"title": "Comment Payload Object",
"type": "object",
"description": "Information about the comment.",
"required": [
"body"
],
"properties": {
"body": {
"type": "string",
"description": "The contents of the comment.",
"example": "This is an example."
},
"tags": {
"type": "object",
"description": "Information about users tagged in the `body` comment.",
"properties": {
"userName": {
"type": "object",
"required": [
"type",
"id"
],
"description": "An object that contains information about the tagged user. The object's name is the user's Postman username. For example, `@user-postman`.",
"properties": {
"type": {
"type": "string",
"description": "The `user` value.",
"enum": [
"user"
],
"example": "user"
},
"id": {
"type": "integer",
"description": "The user's ID.",
"example": 87654321
}
}
}
}
}
}
}