{
"$schema": "https://json-schema.org/draft/2020-12/schema",
"$id": "#/components/schemas/respondPanElementAddRequestResponse",
"title": "Successful Response",
"type": "object",
"properties": {
"request": {
"type": "array",
"description": "Information about the Private API Network request.",
"items": {
"type": "object",
"properties": {
"id": {
"type": "integer",
"description": "The request's ID.",
"example": 2
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the request was created.",
"example": "2022-06-09T14:48:45.000Z"
},
"createdBy": {
"type": "integer",
"description": "The ID of the user who created the request.",
"example": 12345678
},
"message": {
"type": "string",
"description": "The user's optional message included in the request.",
"example": "Please add this element to the network"
},
"response": {
"description": "Information about the response to the element's request. This object only returns when the network manager denied a request with a message.",
"type": "object",
"properties": {
"createdAt": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the network manager denied the request.",
"example": "2020-06-01T08:32:31.000Z"
},
"createdBy": {
"type": "integer",
"description": "The network manager's user ID.",
"example": 87654321
},
"message": {
"type": "string",
"description": "The network manager's request response message.",
"example": "Please fix the API issues first"
}
}
},
"element": {
"description": "Information about the requested element.",
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "The element's ID.",
"example": "5360b75f-447e-467c-9299-12fd3c92450d"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "The date and time at which the element was approved and added to the Private API Network.",
"example": "2022-09-28T13:48:09.000Z"
},
"createdBy": {
"type": "integer",
"description": "The user ID of the user who requested to add the element to the Private API Network.",
"example": 12345678
},
"type": {
"type": "string",
"description": "The element type.",
"enum": [
"api",
"workspace",
"collection"
],
"example": "api"
},
"name": {
"type": "string",
"description": "The element's name.",
"example": "Test API"
},
"summary": {
"type": "string",
"nullable": true,
"description": "If applicable, the element's short summary.",
"example": "This is a test API"
}
}
},
"status": {
"type": "string",
"description": "The request's status.",
"enum": [
"approved",
"denied"
],
"example": "denied"
}
}
}
}
}
}