kenmirrors/asterisk
1
0
Fork 0
mirror of https://github.com/asterisk/asterisk.git synced 2026-05-05 04:43:44 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Add version information to ARI resources and methods.

Browse Source 
* Dump a git blame of each file in rest-api/api-docs.

* Get the commit for each "resourcePath" and "httpMethod" entry.

* Find the tags for each commit (same as other processes).

* Insert a "since" array after each "resourcePath" and "httpMethod" entry.
This commit is contained in:
George Joseph
2025-01-27 08:30:40 -07:00
committed by asterisk-org-access-app[bot]
parent db8ae1912d
commit dfc8652b55
11 changed files with 342 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

39
rest-api/api-docs/recordings.json
View File

@@ -6,6 +6,9 @@
"swaggerVersion": "1.1",
"basePath": "http://localhost:8088/ari",
"resourcePath": "/api-docs/recordings.{format}",
"since": [
"12.0.0"
],
"requiresModules": [
"res_stasis_recording"
],
@@ -16,6 +19,9 @@
"operations": [
{
"httpMethod": "GET",
"since": [
"12.0.0"
],
"summary": "List recordings that are complete.",
"nickname": "listStored",
"responseClass": "List[StoredRecording]"
@@ -28,6 +34,9 @@
"operations": [
{
"httpMethod": "GET",
"since": [
"12.0.0"
],
"summary": "Get a stored recording's details.",
"nickname": "getStored",
"responseClass": "StoredRecording",
@@ -50,6 +59,9 @@
},
{
"httpMethod": "DELETE",
"since": [
"12.0.0"
],
"summary": "Delete a stored recording.",
"nickname": "deleteStored",
"responseClass": "void",
@@ -78,6 +90,9 @@
"operations": [
{
"httpMethod": "GET",
"since": [
"14.0.0"
],
"summary": "Get the file associated with the stored recording.",
"nickname": "getStoredFile",
"responseClass": "binary",
@@ -110,6 +125,9 @@
"operations": [
{
"httpMethod": "POST",
"since": [
"12.5.0"
],
"summary": "Copy a stored recording.",
"nickname": "copyStored",
"responseClass": "StoredRecording",
@@ -150,6 +168,9 @@
"operations": [
{
"httpMethod": "GET",
"since": [
"12.0.0"
],
"summary": "List live recordings.",
"nickname": "getLive",
"responseClass": "LiveRecording",
@@ -172,6 +193,9 @@
},
{
"httpMethod": "DELETE",
"since": [
"12.0.0"
],
"summary": "Stop a live recording and discard it.",
"nickname": "cancel",
"responseClass": "void",
@@ -199,6 +223,9 @@
"operations": [
{
"httpMethod": "POST",
"since": [
"12.0.0"
],
"summary": "Stop a live recording and store it.",
"nickname": "stop",
"responseClass": "void",
@@ -226,6 +253,9 @@
"operations": [
{
"httpMethod": "POST",
"since": [
"12.0.0"
],
"summary": "Pause a live recording.",
"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": "pause",
@@ -253,6 +283,9 @@
},
{
"httpMethod": "DELETE",
"since": [
"12.0.0"
],
"summary": "Unpause a live recording.",
"nickname": "unpause",
"responseClass": "void",
@@ -284,6 +317,9 @@
"operations": [
{
"httpMethod": "POST",
"since": [
"12.0.0"
],
"summary": "Mute a live recording.",
"notes": "Muting a recording suspends silence detection, which will be restarted when the recording is unmuted.",
"nickname": "mute",
@@ -311,6 +347,9 @@
},
{
"httpMethod": "DELETE",
"since": [
"12.0.0"
],
"summary": "Unmute a live recording.",
"nickname": "unmute",
"responseClass": "void",