Document JSON models in resource_*.h
git-svn-id: https://origsvn.digium.com/svn/asterisk/trunk@386462 65c4cc65-6c06-0410-ace0-fbb531ad65f3
This commit is contained in:
parent
22aa2a6e9b
commit
522a969741
|
@ -53,4 +53,10 @@ struct ast_get_asterisk_info_args {
|
||||||
*/
|
*/
|
||||||
void stasis_http_get_asterisk_info(struct ast_variable *headers, struct ast_get_asterisk_info_args *args, struct stasis_http_response *response);
|
void stasis_http_get_asterisk_info(struct ast_variable *headers, struct ast_get_asterisk_info_args *args, struct stasis_http_response *response);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* JSON models
|
||||||
|
*
|
||||||
|
* AsteriskInfo
|
||||||
|
*/
|
||||||
|
|
||||||
#endif /* _ASTERISK_RESOURCE_ASTERISK_H */
|
#endif /* _ASTERISK_RESOURCE_ASTERISK_H */
|
||||||
|
|
|
@ -151,4 +151,12 @@ struct ast_record_bridge_args {
|
||||||
*/
|
*/
|
||||||
void stasis_http_record_bridge(struct ast_variable *headers, struct ast_record_bridge_args *args, struct stasis_http_response *response);
|
void stasis_http_record_bridge(struct ast_variable *headers, struct ast_record_bridge_args *args, struct stasis_http_response *response);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* JSON models
|
||||||
|
*
|
||||||
|
* Bridge
|
||||||
|
* - channels: List[string] (required)
|
||||||
|
* - bridgeType: string (required)
|
||||||
|
*/
|
||||||
|
|
||||||
#endif /* _ASTERISK_RESOURCE_BRIDGES_H */
|
#endif /* _ASTERISK_RESOURCE_BRIDGES_H */
|
||||||
|
|
|
@ -241,4 +241,34 @@ struct ast_record_channel_args {
|
||||||
*/
|
*/
|
||||||
void stasis_http_record_channel(struct ast_variable *headers, struct ast_record_channel_args *args, struct stasis_http_response *response);
|
void stasis_http_record_channel(struct ast_variable *headers, struct ast_record_channel_args *args, struct stasis_http_response *response);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* JSON models
|
||||||
|
*
|
||||||
|
* Originated
|
||||||
|
* DialplanCEP
|
||||||
|
* - priority: long (required)
|
||||||
|
* - exten: string (required)
|
||||||
|
* - context: string (required)
|
||||||
|
* Channel
|
||||||
|
* - accountcode: string (required)
|
||||||
|
* - linkedid: string (required)
|
||||||
|
* - name: string (required)
|
||||||
|
* - userfield: string (required)
|
||||||
|
* - caller: CallerID (required)
|
||||||
|
* - creationtime: Date (required)
|
||||||
|
* - state: string (required)
|
||||||
|
* - parkinglot: string (required)
|
||||||
|
* - peeraccount: string (required)
|
||||||
|
* - appl: string (required)
|
||||||
|
* - connected: CallerID (required)
|
||||||
|
* - uniqueid: string (required)
|
||||||
|
* - hangupsource: string (required)
|
||||||
|
* - dialplan: DialplanCEP (required)
|
||||||
|
* - data: string (required)
|
||||||
|
* CallerID
|
||||||
|
* - name: string (required)
|
||||||
|
* - number: string (required)
|
||||||
|
* Dialed
|
||||||
|
*/
|
||||||
|
|
||||||
#endif /* _ASTERISK_RESOURCE_CHANNELS_H */
|
#endif /* _ASTERISK_RESOURCE_CHANNELS_H */
|
||||||
|
|
|
@ -66,4 +66,12 @@ struct ast_get_endpoint_args {
|
||||||
*/
|
*/
|
||||||
void stasis_http_get_endpoint(struct ast_variable *headers, struct ast_get_endpoint_args *args, struct stasis_http_response *response);
|
void stasis_http_get_endpoint(struct ast_variable *headers, struct ast_get_endpoint_args *args, struct stasis_http_response *response);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* JSON models
|
||||||
|
*
|
||||||
|
* Endpoint
|
||||||
|
* - technology: string (required)
|
||||||
|
* - name: string (required)
|
||||||
|
*/
|
||||||
|
|
||||||
#endif /* _ASTERISK_RESOURCE_ENDPOINTS_H */
|
#endif /* _ASTERISK_RESOURCE_ENDPOINTS_H */
|
||||||
|
|
|
@ -55,4 +55,42 @@ struct ast_event_websocket_args {
|
||||||
*/
|
*/
|
||||||
void stasis_http_event_websocket(struct ast_variable *headers, struct ast_event_websocket_args *args, struct stasis_http_response *response);
|
void stasis_http_event_websocket(struct ast_variable *headers, struct ast_event_websocket_args *args, struct stasis_http_response *response);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* JSON models
|
||||||
|
*
|
||||||
|
* DtmfReceived
|
||||||
|
* - digit: string
|
||||||
|
* - channel: Channel
|
||||||
|
* BridgeCreated
|
||||||
|
* - bridge: Bridge
|
||||||
|
* BridgeDestroyed
|
||||||
|
* - bridge: Bridge
|
||||||
|
* ApplicationReplaced
|
||||||
|
* - application: string
|
||||||
|
* ChannelLeftBridge
|
||||||
|
* - bridge: Bridge
|
||||||
|
* - channel: Channel
|
||||||
|
* StasisStart
|
||||||
|
* - args: List[string]
|
||||||
|
* - channel_info: Channel
|
||||||
|
* StasisEnd
|
||||||
|
* - channel_info: Channel
|
||||||
|
* ChannelStateChange
|
||||||
|
* - channel_info: Channel
|
||||||
|
* ChannelEnteredBridge
|
||||||
|
* - bridge: Bridge
|
||||||
|
* - channel: Channel
|
||||||
|
* Event
|
||||||
|
* - stasis_start: StasisStart
|
||||||
|
* - channel_entered_bridge: ChannelEnteredBridge
|
||||||
|
* - channel_left_bridge: ChannelLeftBridge
|
||||||
|
* - application_replaced: ApplicationReplaced
|
||||||
|
* - channel_state_change: ChannelStateChange
|
||||||
|
* - bridge_created: BridgeCreated
|
||||||
|
* - application: string (required)
|
||||||
|
* - stasis_end: StasisEnd
|
||||||
|
* - dtmf_received: DtmfReceived
|
||||||
|
* - bridge_destroyed: BridgeDestroyed
|
||||||
|
*/
|
||||||
|
|
||||||
#endif /* _ASTERISK_RESOURCE_EVENTS_H */
|
#endif /* _ASTERISK_RESOURCE_EVENTS_H */
|
||||||
|
|
|
@ -81,4 +81,11 @@ struct ast_control_playback_args {
|
||||||
*/
|
*/
|
||||||
void stasis_http_control_playback(struct ast_variable *headers, struct ast_control_playback_args *args, struct stasis_http_response *response);
|
void stasis_http_control_playback(struct ast_variable *headers, struct ast_control_playback_args *args, struct stasis_http_response *response);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* JSON models
|
||||||
|
*
|
||||||
|
* Playback
|
||||||
|
* - id: string (required)
|
||||||
|
*/
|
||||||
|
|
||||||
#endif /* _ASTERISK_RESOURCE_PLAYBACK_H */
|
#endif /* _ASTERISK_RESOURCE_PLAYBACK_H */
|
||||||
|
|
|
@ -190,4 +190,18 @@ struct ast_unmute_recording_args {
|
||||||
*/
|
*/
|
||||||
void stasis_http_unmute_recording(struct ast_variable *headers, struct ast_unmute_recording_args *args, struct stasis_http_response *response);
|
void stasis_http_unmute_recording(struct ast_variable *headers, struct ast_unmute_recording_args *args, struct stasis_http_response *response);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* JSON models
|
||||||
|
*
|
||||||
|
* Recording
|
||||||
|
* - id: string (required)
|
||||||
|
* StoredRecording
|
||||||
|
* - durationSeconds: int
|
||||||
|
* - time: Date
|
||||||
|
* - id: string (required)
|
||||||
|
* - formats: List[string] (required)
|
||||||
|
* LiveRecording
|
||||||
|
* - id: string (required)
|
||||||
|
*/
|
||||||
|
|
||||||
#endif /* _ASTERISK_RESOURCE_RECORDINGS_H */
|
#endif /* _ASTERISK_RESOURCE_RECORDINGS_H */
|
||||||
|
|
|
@ -66,4 +66,14 @@ struct ast_get_stored_sound_args {
|
||||||
*/
|
*/
|
||||||
void stasis_http_get_stored_sound(struct ast_variable *headers, struct ast_get_stored_sound_args *args, struct stasis_http_response *response);
|
void stasis_http_get_stored_sound(struct ast_variable *headers, struct ast_get_stored_sound_args *args, struct stasis_http_response *response);
|
||||||
|
|
||||||
|
/*
|
||||||
|
* JSON models
|
||||||
|
*
|
||||||
|
* Sound
|
||||||
|
* - lang: string (required)
|
||||||
|
* - text: string
|
||||||
|
* - id: string (required)
|
||||||
|
* - formats: List[string] (required)
|
||||||
|
*/
|
||||||
|
|
||||||
#endif /* _ASTERISK_RESOURCE_SOUNDS_H */
|
#endif /* _ASTERISK_RESOURCE_SOUNDS_H */
|
||||||
|
|
|
@ -64,5 +64,16 @@ void stasis_http_{{c_nickname}}(struct ast_variable *headers, struct ast_{{c_nic
|
||||||
{{/operations}}
|
{{/operations}}
|
||||||
{{/apis}}
|
{{/apis}}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* JSON models
|
||||||
|
*
|
||||||
|
{{#models}}
|
||||||
|
* {{id}}
|
||||||
|
{{#properties}}
|
||||||
|
* - {{name}}: {{type}} {{#required}}(required){{/required}}
|
||||||
|
{{/properties}}
|
||||||
|
{{/models}}
|
||||||
|
*/
|
||||||
|
|
||||||
#endif /* _ASTERISK_RESOURCE_{{name_caps}}_H */
|
#endif /* _ASTERISK_RESOURCE_{{name_caps}}_H */
|
||||||
{{/api_declaration}}
|
{{/api_declaration}}
|
||||||
|
|
Loading…
Reference in New Issue