[asterisk-bugs] [JIRA] (ASTERISK-27737) 'identify_by' pjsip.conf option documentation is wrong

[Jacek Konieczny (JIRA)]

     [ https://issues.asterisk.org/jira/browse/ASTERISK-27737?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel ]

Jacek Konieczny updated ASTERISK-27737:
---------------------------------------

    Description: 
The table at the top of https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip shows the default value to be '{{username,location}}'.

Then, in the [option description|https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip#Asterisk15Configuration_res_pjsip-endpoint_identify_by], {{username}} and {{auth_username}} are listed as valid values.

Identification by the {{identify}} section is mentioned in a way that suggests that only {{identify}} section would be used when {{identify_by}} is not set.

The actual behaviour is quite different:
* The accepted values are: {{username}}, {{auth_username}} and {{ip}}
* The default value is: {{username,ip}}
* …which is used when {{identify_by}} is not set in the config file, so existing {{identify}} section is used *in addition* to the user name.

Also, [res_pjsip_endpoint_identifier_ip documentation|https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip_endpoint_identifier_ip] does not mention {{identify_by}} at all, while its value influences how {{identify}} section will work.

That mismatch between documentation and actual behaviour may be quite confusing.

  was:
The table at the top of https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip shows the default value to be '{{username,location}}'.

Then, in the [option description|https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip#Asterisk15Configuration_res_pjsip-endpoint_identify_by], {{username}} and {{auth_username}} are listed as valid values.

Identification by the {{identify}} section is mentioned in a way that suggests that only {{identify}} section would be used when {{identify_by}} is not set.

The actual behaviour is quite different:
* The accepted values are: {{username}}, {{auth_username}} and {{ip}}
* The default value is: {{username,ip}}
* …which is used when {{identify_by}} is not set in the config file, so existing {{identify}} section is used *in addition* to the user name.

That mismatch between documentation and actual behaviour may be quite confusing.


> 'identify_by' pjsip.conf option documentation is wrong
> ------------------------------------------------------
>
>                 Key: ASTERISK-27737
>                 URL: https://issues.asterisk.org/jira/browse/ASTERISK-27737
>             Project: Asterisk
>          Issue Type: Bug
>      Security Level: None
>          Components: Documentation
>    Affects Versions: 15.2.2
>            Reporter: Jacek Konieczny
>              Labels: pjsip
>
> The table at the top of https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip shows the default value to be '{{username,location}}'.
> Then, in the [option description|https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip#Asterisk15Configuration_res_pjsip-endpoint_identify_by], {{username}} and {{auth_username}} are listed as valid values.
> Identification by the {{identify}} section is mentioned in a way that suggests that only {{identify}} section would be used when {{identify_by}} is not set.
> The actual behaviour is quite different:
> * The accepted values are: {{username}}, {{auth_username}} and {{ip}}
> * The default value is: {{username,ip}}
> * …which is used when {{identify_by}} is not set in the config file, so existing {{identify}} section is used *in addition* to the user name.
> Also, [res_pjsip_endpoint_identifier_ip documentation|https://wiki.asterisk.org/wiki/display/AST/Asterisk+15+Configuration_res_pjsip_endpoint_identifier_ip] does not mention {{identify_by}} at all, while its value influences how {{identify}} section will work.
> That mismatch between documentation and actual behaviour may be quite confusing.



--
This message was sent by Atlassian JIRA
(v6.2#6252)