George Joseph
d5e7988df4
docs: Enable since/version handling for XML, CLI and ARI documentation
...
* Added the "since" element to the XML configObject and configOption elements
in appdocsxml.dtd.
* Added the "Since" section to the following CLI output:
```
config show help <module> <object>
config show help <module> <object> <option>
core show application <app>
core show function <func>
manager show command <command>
manager show event <event>
agi show commands topic <topic>
```
* Refactored the commands above to output their sections in the same order:
Synopsis, Since, Description, Syntax, Arguments, SeeAlso
* Refactored the commands above so they all use the same pattern for writing
the output to the CLI.
* Fixed several memory leaks caused by failure to free temporary output
buffers.
* Added a "since" array to the mustache template for the top-level resources
(Channel, Endpoint, etc.) and to the paths/methods underneath them. These
will be added to the generated markdown if present.
Example:
```
"resourcePath": "/api-docs/channels.{format}",
"requiresModules": [
"res_stasis_answer",
"res_stasis_playback",
"res_stasis_recording",
"res_stasis_snoop"
],
"since": [
"18.0.0",
"21.0.0"
],
"apis": [
{
"path": "/channels",
"description": "Active channels",
"operations": [
{
"httpMethod": "GET",
"since": [
"18.6.0",
"21.8.0"
],
"summary": "List all active channels in Asterisk.",
"nickname": "list",
"responseClass": "List[Channel]"
},
```
NOTE: No versioning information is actually added in this commit.
Those will be added separately and instructions for adding and maintaining
them will be published on the documentation site at a later date.
2025-01-16 14:20:38 +00:00
..
2024-03-18 08:20:06 -06:00
2024-08-12 15:21:02 +00:00
2025-01-13 17:08:49 +00:00
2023-08-04 14:21:18 +00:00
2023-01-31 12:59:16 -06:00
2023-07-12 17:38:58 +00:00
2025-01-13 17:08:49 +00:00
2024-02-28 18:38:58 +00:00
2024-11-20 21:38:39 +00:00
2024-03-18 08:20:06 -06:00
2017-10-18 03:34:56 -05:00
2024-08-06 18:04:45 +00:00
2022-03-23 18:08:17 -05:00
2023-04-03 07:13:57 -05:00
2024-03-18 08:20:06 -06:00
2022-04-26 14:26:48 -05:00
2022-04-26 14:26:48 -05:00
2024-03-18 08:20:06 -06:00
2025-01-16 14:20:38 +00:00
2021-11-18 16:25:51 -06:00
2021-11-18 16:25:51 -06:00
2021-11-18 16:25:51 -06:00
2021-11-18 16:25:51 -06:00
2021-11-18 16:25:51 -06:00
2023-08-09 15:10:39 +00:00
2021-11-18 16:25:51 -06:00
2021-11-18 16:25:51 -06:00
2017-04-12 15:57:21 -06:00
2021-11-18 16:25:51 -06:00
2021-11-18 16:25:51 -06:00
2021-11-18 16:25:51 -06:00
2024-05-14 08:01:52 -06:00
2024-03-18 08:20:06 -06:00
2020-01-14 09:36:44 -06:00
2024-06-07 16:24:27 +00:00
2024-03-18 08:20:06 -06:00
2024-03-18 08:20:06 -06:00
2024-03-18 08:20:06 -06:00
2024-03-18 08:20:06 -06:00
2021-12-03 10:38:39 -06:00
2024-02-12 18:46:27 +00:00
2022-07-08 09:28:23 -05:00
2021-11-15 16:37:34 -06:00
2024-03-18 08:20:06 -06:00
2023-08-14 17:20:01 +00:00
2024-03-18 08:20:06 -06:00
2022-08-01 09:58:58 -05:00
2017-12-22 09:23:22 -05:00
2021-11-15 16:37:34 -06:00
2023-06-12 17:20:24 +00:00
2018-01-24 13:37:29 -05:00
2018-01-15 13:25:51 -05:00
2023-06-12 17:19:22 +00:00
2025-01-13 17:08:49 +00:00
2021-03-10 04:22:36 -06:00
2021-03-10 04:22:36 -06:00
2018-12-13 17:03:59 -05:00
2021-06-10 16:30:28 -05:00
2021-03-10 04:22:36 -06:00
2021-03-10 04:22:36 -06:00
2021-03-10 04:22:36 -06:00
2021-03-10 04:22:36 -06:00
2021-03-10 04:22:36 -06:00
2022-07-12 07:52:12 -05:00
2022-07-12 07:52:12 -05:00
2024-03-18 08:20:06 -06:00
2024-03-18 08:20:06 -06:00
2024-03-18 08:20:06 -06:00
2023-03-06 12:16:08 -06:00
2021-11-15 16:37:34 -06:00
2024-02-12 18:46:27 +00:00
2017-12-22 09:23:22 -05:00
2025-01-13 17:08:49 +00:00
2025-01-13 17:08:49 +00:00
2025-01-13 17:08:49 +00:00
2023-06-29 15:15:03 +00:00
2025-01-13 17:08:49 +00:00
2019-04-23 17:40:15 -05:00
2025-01-13 17:08:49 +00:00
2021-12-03 10:38:39 -06:00
2021-02-25 08:45:30 -06:00
2023-12-06 21:19:13 +00:00
2021-11-18 16:59:26 -06:00
2024-03-18 08:20:06 -06:00
2023-12-20 14:02:22 +00:00
2018-09-06 13:30:12 -05:00
2020-02-20 04:52:11 -06:00
2024-03-18 08:20:06 -06:00
2023-10-20 12:18:53 +00:00
2024-02-28 18:38:58 +00:00
2024-07-24 19:21:12 +00:00
2022-09-13 04:51:00 -05:00
2022-09-13 04:51:00 -05:00
2020-11-19 16:14:33 -06:00
2023-10-27 15:52:39 +00:00
2020-04-20 11:03:26 -05:00
2022-09-13 04:51:00 -05:00
2021-03-05 10:32:28 -06:00
2023-10-20 12:18:53 +00:00
2023-10-20 12:39:04 +00:00
2022-09-26 15:03:32 -05:00
2023-12-14 18:48:35 +00:00
2024-03-18 08:20:06 -06:00
2022-10-27 09:00:29 -05:00
2023-08-09 15:10:39 +00:00
2018-01-24 13:37:29 -05:00
2023-10-20 12:39:04 +00:00
2024-01-08 17:26:24 +00:00
2025-01-13 17:08:49 +00:00
2020-04-20 11:03:26 -05:00
2022-10-27 14:29:45 -05:00
2018-11-21 09:56:16 -05:00
2025-01-13 17:08:49 +00:00
2022-12-20 08:52:49 -06:00
2024-03-18 08:20:06 -06:00
2018-01-24 13:37:29 -05:00
2020-12-16 08:01:11 -06:00
2018-01-24 13:37:29 -05:00
2021-11-18 12:14:54 -06:00
2025-01-13 17:08:49 +00:00
2023-08-09 15:10:39 +00:00
2025-01-13 17:08:49 +00:00
2023-06-21 13:24:54 +00:00
2023-05-02 15:19:56 +00:00
2024-11-13 16:06:52 +00:00
2018-01-24 13:37:29 -05:00
2024-02-28 18:38:58 +00:00
2024-02-28 18:38:58 +00:00
2018-01-24 13:37:29 -05:00
2024-05-14 08:09:05 -06:00
2024-01-30 19:06:36 +00:00
2023-09-21 14:47:50 +00:00
2018-01-24 13:37:29 -05:00
2024-01-08 17:26:24 +00:00
2022-01-17 08:25:58 -06:00
2021-11-15 16:37:34 -06:00
2024-03-18 08:20:06 -06:00
2019-05-20 20:33:58 -05:00
2020-01-14 10:07:20 -06:00
2021-03-16 10:30:43 -05:00
2024-09-05 16:32:30 +00:00
2024-02-14 15:05:35 +00:00
2017-12-22 09:23:22 -05:00
2018-11-18 15:08:16 -05:00
2024-03-18 08:20:06 -06:00
2024-03-18 08:20:06 -06:00
2017-12-10 12:51:16 -06:00
2021-11-15 16:37:34 -06:00
2025-01-13 17:08:49 +00:00
2018-11-21 09:56:16 -05:00
2018-08-17 16:33:24 -05:00
2023-10-05 14:36:07 +00:00
2024-02-12 18:46:27 +00:00
2023-12-08 13:11:48 +00:00
2018-01-15 13:25:51 -05:00
2018-11-21 09:56:16 -05:00
2018-01-24 13:37:29 -05:00
2021-11-15 16:37:34 -06:00
2023-09-13 17:34:31 +00:00
2023-01-30 08:26:18 -06:00
2018-09-12 12:34:54 -05:00
2024-08-06 18:04:45 +00:00
2024-03-18 08:20:06 -06:00
2024-09-17 16:15:27 +00:00
2020-06-08 10:50:16 -05:00
2021-12-03 10:38:39 -06:00
2023-12-08 13:11:48 +00:00
2024-03-18 08:20:06 -06:00
2024-03-18 08:20:06 -06:00
2024-03-18 08:20:06 -06:00
2025-01-13 17:08:49 +00:00
2024-11-04 08:42:01 -07:00