summaryrefslogtreecommitdiff
path: root/rest-api/api-docs/recordings.json
diff options
context:
space:
mode:
Diffstat (limited to 'rest-api/api-docs/recordings.json')
-rw-r--r--rest-api/api-docs/recordings.json60
1 files changed, 59 insertions, 1 deletions
diff --git a/rest-api/api-docs/recordings.json b/rest-api/api-docs/recordings.json
index b564edee0..b4dd6d090 100644
--- a/rest-api/api-docs/recordings.json
+++ b/rest-api/api-docs/recordings.json
@@ -87,6 +87,12 @@
"allowMultiple": false,
"dataType": "string"
}
+ ],
+ "errorResponses": [
+ {
+ "code": 404,
+ "reason": "Recording not found"
+ }
]
},
{
@@ -103,6 +109,12 @@
"allowMultiple": false,
"dataType": "string"
}
+ ],
+ "errorResponses": [
+ {
+ "code": 404,
+ "reason": "Recording not found"
+ }
]
}
]
@@ -124,6 +136,12 @@
"allowMultiple": false,
"dataType": "string"
}
+ ],
+ "errorResponses": [
+ {
+ "code": 404,
+ "reason": "Recording not found"
+ }
]
}
]
@@ -134,7 +152,7 @@
{
"httpMethod": "POST",
"summary": "Pause a live recording.",
- "notes": "Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused.",
+ "notes": "Pausing a recording suspends silence detection, which will be restarted when the recording is unpaused. Paused time is not included in the accounting for maxDurationSeconds.",
"nickname": "pauseRecording",
"responseClass": "void",
"parameters": [
@@ -146,6 +164,16 @@
"allowMultiple": false,
"dataType": "string"
}
+ ],
+ "errorResponses": [
+ {
+ "code": 404,
+ "reason": "Recording not found"
+ },
+ {
+ "code": 409,
+ "reason": "Recording not in session"
+ }
]
}
]
@@ -167,6 +195,16 @@
"allowMultiple": false,
"dataType": "string"
}
+ ],
+ "errorResponses": [
+ {
+ "code": 404,
+ "reason": "Recording not found"
+ },
+ {
+ "code": 409,
+ "reason": "Recording not in session"
+ }
]
}
]
@@ -189,6 +227,16 @@
"allowMultiple": false,
"dataType": "string"
}
+ ],
+ "errorResponses": [
+ {
+ "code": 404,
+ "reason": "Recording not found"
+ },
+ {
+ "code": 409,
+ "reason": "Recording not in session"
+ }
]
}
]
@@ -210,6 +258,16 @@
"allowMultiple": false,
"dataType": "string"
}
+ ],
+ "errorResponses": [
+ {
+ "code": 404,
+ "reason": "Recording not found"
+ },
+ {
+ "code": 409,
+ "reason": "Recording not in session"
+ }
]
}
]