mirror of
https://github.com/apache/superset.git
synced 2026-08-04 04:52:32 +00:00
113 lines
3.2 KiB
JSON
113 lines
3.2 KiB
JSON
{
|
|
"responses": {
|
|
"201": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": {
|
|
"id": { "type": "number" },
|
|
"result": {
|
|
"properties": {
|
|
"end_dttm": {
|
|
"description": "The annotation end date time",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
},
|
|
"json_metadata": {
|
|
"description": "JSON metadata",
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"long_descr": {
|
|
"description": "A long description",
|
|
"nullable": true,
|
|
"type": "string"
|
|
},
|
|
"short_descr": {
|
|
"description": "A short description",
|
|
"maxLength": 500,
|
|
"minLength": 1,
|
|
"type": "string"
|
|
},
|
|
"start_dttm": {
|
|
"description": "The annotation start date time",
|
|
"format": "date-time",
|
|
"type": "string"
|
|
}
|
|
},
|
|
"required": ["end_dttm", "short_descr", "start_dttm"],
|
|
"type": "object",
|
|
"title": "AnnotationRestApi.post"
|
|
}
|
|
},
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"id": 1,
|
|
"result": {
|
|
"end_dttm": "2024-01-15T10:30:00Z",
|
|
"json_metadata": "string",
|
|
"long_descr": "string",
|
|
"short_descr": "string",
|
|
"start_dttm": "2024-01-15T10:30:00Z"
|
|
}
|
|
}
|
|
}
|
|
},
|
|
"description": "Annotation added"
|
|
},
|
|
"400": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": { "message": "Bad request: Invalid parameters provided" }
|
|
}
|
|
},
|
|
"description": "Bad request"
|
|
},
|
|
"401": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": { "message": "Unauthorized: Authentication required" }
|
|
}
|
|
},
|
|
"description": "Unauthorized"
|
|
},
|
|
"404": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"message": "Not found: The requested resource does not exist"
|
|
}
|
|
}
|
|
},
|
|
"description": "Not found"
|
|
},
|
|
"500": {
|
|
"content": {
|
|
"application/json": {
|
|
"schema": {
|
|
"properties": { "message": { "type": "string" } },
|
|
"type": "object"
|
|
},
|
|
"example": {
|
|
"message": "Internal server error: An unexpected error occurred"
|
|
}
|
|
}
|
|
},
|
|
"description": "Fatal error"
|
|
}
|
|
}
|
|
}
|