docs: Add version information to ARI resources and methods.

* 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.

(cherry picked from commit a84d4cd0b4)
This commit is contained in:
George Joseph
2025-01-27 08:30:40 -07:00
committed by Asterisk Development Team
parent 3f15501335
commit e938771ac8
11 changed files with 342 additions and 0 deletions

View File

@@ -6,6 +6,9 @@
"swaggerVersion": "1.1",
"basePath": "http://localhost:8088/ari",
"resourcePath": "/api-docs/applications.{format}",
"since": [
"13.0.0"
],
"apis": [
{
"path": "/applications",
@@ -13,6 +16,9 @@
"operations": [
{
"httpMethod": "GET",
"since": [
"13.0.0"
],
"summary": "List all applications.",
"nickname": "list",
"responseClass": "List[Application]"
@@ -25,6 +31,9 @@
"operations": [
{
"httpMethod": "GET",
"since": [
"13.0.0"
],
"summary": "Get details of an application.",
"nickname": "get",
"responseClass": "Application",
@@ -53,6 +62,9 @@
"operations": [
{
"httpMethod": "POST",
"since": [
"13.0.0"
],
"summary": "Subscribe an application to a event source.",
"notes": "Returns the state of the application after the subscriptions have changed",
"nickname": "subscribe",
@@ -92,6 +104,9 @@
},
{
"httpMethod": "DELETE",
"since": [
"13.0.0"
],
"summary": "Unsubscribe an application from an event source.",
"notes": "Returns the state of the application after the subscriptions have changed",
"nickname": "unsubscribe",
@@ -141,6 +156,10 @@
"operations": [
{
"httpMethod": "PUT",
"since": [
"13.26.0",
"16.3.0"
],
"summary": "Filter application events types.",
"notes": "Allowed and/or disallowed event type filtering can be done. The body (parameter) should specify a JSON key/value object that describes the type of event filtering needed. One, or both of the following keys can be designated:<br /><br />\"allowed\" - Specifies an allowed list of event types<br />\"disallowed\" - Specifies a disallowed list of event types<br /><br />Further, each of those key's value should be a JSON array that holds zero, or more JSON key/value objects. Each of these objects must contain the following key with an associated value:<br /><br />\"type\" - The type name of the event to filter<br /><br />The value must be the string name (case sensitive) of the event type that needs filtering. For example:<br /><br />{ \"allowed\": [ { \"type\": \"StasisStart\" }, { \"type\": \"StasisEnd\" } ] }<br /><br />As this specifies only an allowed list, then only those two event type messages are sent to the application. No other event messages are sent.<br /><br />The following rules apply:<br /><br />* If the body is empty, both the allowed and disallowed filters are set empty.<br />* If both list types are given then both are set to their respective values (note, specifying an empty array for a given type sets that type to empty).<br />* If only one list type is given then only that type is set. The other type is not updated.<br />* An empty \"allowed\" list means all events are allowed.<br />* An empty \"disallowed\" list means no events are disallowed.<br />* Disallowed events take precedence over allowed events if the event type is specified in both lists.",
"nickname": "filter",