Summary:	ASTERISK-28717: ARI Data Model DialplanCEP - Missing required properties
Reporter:	Lukas Stermann (Oktavlachs)	Labels:	ARI
Date Opened:	2020-01-27 16:15:07.000-0600	Date Closed:	2020-02-12 12:00:01.000-0600
Priority:	Minor	Regression?
Status:	Closed/Complete	Components:	Documentation Resources/res_ari_channels
Versions:	16.3.0	Frequency of Occurrence	Constant
Related Issues:
Environment:		Attachments:
Description:	In the documentation of the ARI data model 'DialplanCEP' the properties 'app_data' and 'app_name' are marked as required (https://wiki.asterisk.org/wiki/display/AST/Asterisk+16+REST+Data+Models#Asterisk16RESTDataModels-DialplanCEP). Expectation: 'app_name' and 'app_data' properties are provided by any ARI Message that holds a 'DialplanCEP' model. Reality: If a Channel's state is 'Down', both  'app_name' and 'app_data' properties are not present in the 'DialplanCEP' model (e.g. in case of a ChannelHangupRequest event) Possible solution: Mark 'app_name' and 'app_data' as not required in the documentation of the 'DialplanCEP' data model.
Comments:	By: Asterisk Team (asteriskteam) 2020-01-27 16:15:09.170-0600 Thanks for creating a report! The issue has entered the triage process. That means the issue will wait in this status until a Bug Marshal has an opportunity to review the issue. Once the issue has been reviewed you will receive comments regarding the next steps towards resolution. A good first step is for you to review the [Asterisk Issue Guidelines|https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines] if you haven't already. The guidelines detail what is expected from an Asterisk issue report. Then, if you are submitting a patch, please review the [Patch Contribution Process|https://wiki.asterisk.org/wiki/display/AST/Patch+Contribution+Process]. Please note that once your issue enters an open state it has been accepted. As Asterisk is an open source project there is no guarantee or timeframe on when your issue will be looked into. If you need expedient resolution you will need to find and pay a suitable developer. Asking for an update on your issue will not yield any progress on it and will not result in a response. All updates are posted to the issue when they occur. By: Benjamin Keith Ford (bford) 2020-01-28 09:49:28.748-0600 Hey [~Oktavlachs], is there a specific scenario you've come across where this is an issue? By: Lukas Stermann (Oktavlachs) 2020-01-28 12:00:13.920-0600 Hey [~bford], thank you for your quick response! The issue occurred in a live environment and was sent automatically to my bug reporting service. The error was constantly sent in the same context. What I can provide is the ARI Channel data model JSON representation, which was associated with an incoming ChannelHangupRequest Event emitted by the ARI: "{"id":"1580135719.6973","name":"PJSIP/class4-00001b16","state":"Down","caller":{"name":"","number":"+XXXXXXXXXX"},"connected":{"name":"","number":"+XXXXXXXXXX"},"accountcode":"XXXXXXXXXXXXXX.XXXX","dialplan":{"context":"stasis-InboundCall","exten":"s","priority":1},"creationtime":"2020-01-XXT14:35:19.075+0000","language":"en","channelvars":{.........}}" Where 'X' and '........' is of course hiding sensitive information here. Does that help? By: Benjamin Keith Ford (bford) 2020-01-28 12:23:19.261-0600 It's good information to have. If there is an error message that you see that's relevant to the problem, what does it say? Also, do you have steps that can reliably reproduce the problem? That would help both with debugging and testing solutions. By: Lukas Stermann (Oktavlachs) 2020-01-28 13:13:23.096-0600 Okay I see. I will not be able to reproduce it in the next days but will try and come back to you in the next two weeks. For now: There are no error messages from Asterisk or HTTP Error codes from ARI involved as far as I can see. Thank you! By: Benjamin Keith Ford (bford) 2020-01-29 09:24:55.336-0600 Sounds good! I'll put this in Waiting for Feedback for now. The ticket will automatically close in 2 weeks, but all you need to do is leave a comment with your findings (when you're ready) and the ticket will automatically re-open. By: Asterisk Team (asteriskteam) 2020-02-12 12:00:01.153-0600 Suspended due to lack of activity. This issue will be automatically re-opened if the reporter posts a comment. If you are not the reporter and would like this re-opened please create a new issue instead. If the new issue is related to this one a link will be created during the triage process. Further information on issue tracker usage can be found in the Asterisk Issue Guidlines [1]. [1] https://wiki.asterisk.org/wiki/display/AST/Asterisk+Issue+Guidelines