mirror of
https://github.com/asterisk/asterisk.git
synced 2025-09-03 11:25:35 +00:00
docs: Add version information to configObject and configOption XML elements
Most of the configObjects and configOptions that are implemented with
ACO or Sorcery now have `<since>/<version>` elements added. There are
probably some that the script I used didn't catch. The version tags were
determined by the following...
* Do a git blame on the API call that created the object or option.
* From the commit hash, grab the summary line.
* Do a `git log --grep <summary>` to find the cherry-pick commits in all
branches that match.
* Do a `git patch-id` to ensure the commits are all related and didn't get
a false match on the summary.
* Do a `git tag --contains <commit>` to find the tags that contain each
commit.
* Weed out all tags not <major>.<minor>.0.
* Sort and discard any <major>.0.0 and following tags where the commit
appeared in an earlier branch.
* The result is a single tag for each branch where the API was last touched.
configObjects and configOptions elements implemented with the base
ast_config APIs were just not possible to find due to the non-deterministic
way they are accessed.
Also note that if the API call was on modified after it was added, the
version will be the one it was last modified in.
Final note: The configObject and configOption elements were introduced in
12.0.0 so options created before then may not have any XML documentation.
(cherry picked from commit a22dc33057
)
This commit is contained in:
committed by
Asterisk Development Team
parent
e7801702c6
commit
1ccf0ae7e8
@@ -148,6 +148,7 @@
|
||||
</configOption>
|
||||
</configObject>
|
||||
<configObject name="resource_list">
|
||||
<since><version>13.0.0</version></since>
|
||||
<synopsis>Resource list configuration parameters.</synopsis>
|
||||
<description>
|
||||
<para>This configuration object allows for RFC 4662 resource list subscriptions
|
||||
@@ -160,9 +161,11 @@
|
||||
</note>
|
||||
</description>
|
||||
<configOption name="type">
|
||||
<since><version>13.0.0</version></since>
|
||||
<synopsis>Must be of type 'resource_list'</synopsis>
|
||||
</configOption>
|
||||
<configOption name="event">
|
||||
<since><version>13.0.0</version></since>
|
||||
<synopsis>The SIP event package that the list resource belong to.</synopsis>
|
||||
<description><para>
|
||||
The SIP event package describes the types of resources that Asterisk reports
|
||||
@@ -182,6 +185,7 @@
|
||||
</description>
|
||||
</configOption>
|
||||
<configOption name="list_item">
|
||||
<since><version>13.0.0</version></since>
|
||||
<synopsis>The name of a resource to report state on</synopsis>
|
||||
<description>
|
||||
<para>In general Asterisk looks up list items in the following way:</para>
|
||||
@@ -196,6 +200,7 @@
|
||||
</description>
|
||||
</configOption>
|
||||
<configOption name="full_state" default="no">
|
||||
<since><version>13.0.0</version></since>
|
||||
<synopsis>Indicates if the entire list's state should be sent out.</synopsis>
|
||||
<description>
|
||||
<para>If this option is enabled, and a resource changes state, then Asterisk will construct
|
||||
@@ -211,6 +216,7 @@
|
||||
</description>
|
||||
</configOption>
|
||||
<configOption name="notification_batch_interval" default="0">
|
||||
<since><version>13.0.0</version></since>
|
||||
<synopsis>Time Asterisk should wait, in milliseconds, before sending notifications.</synopsis>
|
||||
<description>
|
||||
<para>When a resource's state changes, it may be desired to wait a certain amount before Asterisk
|
||||
@@ -220,6 +226,7 @@
|
||||
</description>
|
||||
</configOption>
|
||||
<configOption name="resource_display_name" default="no">
|
||||
<since><version>16.25.0</version><version>18.11.0</version><version>19.3.0</version></since>
|
||||
<synopsis>Indicates whether display name of resource or the resource name being reported.</synopsis>
|
||||
<description>
|
||||
<para>If this option is enabled, the Display Name will be reported as resource name.
|
||||
@@ -230,11 +237,14 @@
|
||||
</configOption>
|
||||
</configObject>
|
||||
<configObject name="inbound-publication">
|
||||
<since><version>13.0.0</version></since>
|
||||
<synopsis>The configuration for inbound publications</synopsis>
|
||||
<configOption name="endpoint" default="">
|
||||
<since><version>13.0.0</version></since>
|
||||
<synopsis>Optional name of an endpoint that is only allowed to publish to this resource</synopsis>
|
||||
</configOption>
|
||||
<configOption name="type">
|
||||
<since><version>13.0.0</version></since>
|
||||
<synopsis>Must be of type 'inbound-publication'.</synopsis>
|
||||
</configOption>
|
||||
</configObject>
|
||||
|
Reference in New Issue
Block a user