Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[bug]: PJSIP_RESPONSE_HEADERS function documentation is misleading #230

Closed
1 task done
alipsitz-sf opened this issue Aug 8, 2023 · 0 comments · Fixed by #250
Closed
1 task done

[bug]: PJSIP_RESPONSE_HEADERS function documentation is misleading #230

alipsitz-sf opened this issue Aug 8, 2023 · 0 comments · Fixed by #250
Labels
bug support-level-core Functionality with core support level

Comments

@alipsitz-sf
Copy link

Severity

Trivial

Versions

18.16.0

Components/Modules

pjsip, Dialplan

Operating Environment

Debian bullseye/sid, FreePBX

Frequency of Occurrence

None

Issue Description

The documentation for PJSIP_HEADERS describes a parameter called prefix and uses the wording "if specified", which heavily implies that the parameter is optional.

However, in the actual implementation a zero-length prefix is not allowed.

Admittedly, it would be more convenient for my use-case if the function worked as described in the documentation (in other words, the parameter is optional and when not provided the function returns all headers). I understand that borders on a feature request, so it would be nice to have the documentation say "required" instead of "if specified".

Relevant log output

res_pjsip_header_funcs.c: This function requires a pattern.

Asterisk Issue Guidelines

  • Yes, I have read the Asterisk Issue Guidelines
@jcolp jcolp added support-level-core Functionality with core support level and removed triage labels Aug 8, 2023
InterLinked1 added a commit to InterLinked1/asterisk that referenced this issue Aug 9, 2023
@InterLinked1
res_pjsip_header_funcs: Make prefix argument optional.
1d7c71a 
The documentation for PJSIP_HEADERS claims that
prefix is optional, but in the code it is actually not.
However, there is no inherent reason for this, as users
may want to retrieve all header names, not just those
beginning with a certain prefix.

This makes the prefix optional for this function,
simply fetching all header names if not specified.
As a result, the documentation is now correct.

Resolves: asterisk#230

UserNote: The prefix argument to PJSIP_HEADERS is now
optional. If not specified, all header names will be
returned.
InterLinked1 added a commit to InterLinked1/asterisk that referenced this issue Aug 9, 2023
@InterLinked1
res_pjsip_header_funcs: Make prefix argument optional.
d088cde 
The documentation for PJSIP_HEADERS claims that
prefix is optional, but in the code it is actually not.
However, there is no inherent reason for this, as users
may want to retrieve all header names, not just those
beginning with a certain prefix.

This makes the prefix optional for this function,
simply fetching all header names if not specified.
As a result, the documentation is now correct.

Resolves: asterisk#230

UserNote: The prefix argument to PJSIP_HEADERS is now
optional. If not specified, all header names will be
returned.
@InterLinked1 InterLinked1 mentioned this issue Aug 9, 2023
Merged
asterisk-org-access-app bot pushed a commit that referenced this issue Aug 14, 2023
@InterLinked1
res_pjsip_header_funcs: Make prefix argument optional.
08e7d77 
The documentation for PJSIP_HEADERS claims that
prefix is optional, but in the code it is actually not.
However, there is no inherent reason for this, as users
may want to retrieve all header names, not just those
beginning with a certain prefix.

This makes the prefix optional for this function,
simply fetching all header names if not specified.
As a result, the documentation is now correct.

Resolves: #230

UserNote: The prefix argument to PJSIP_HEADERS is now
optional. If not specified, all header names will be
returned.
asterisk-org-access-app bot pushed a commit that referenced this issue Aug 14, 2023
@InterLinked1
res_pjsip_header_funcs: Make prefix argument optional.
8be503b 
The documentation for PJSIP_HEADERS claims that
prefix is optional, but in the code it is actually not.
However, there is no inherent reason for this, as users
may want to retrieve all header names, not just those
beginning with a certain prefix.

This makes the prefix optional for this function,
simply fetching all header names if not specified.
As a result, the documentation is now correct.

Resolves: #230

UserNote: The prefix argument to PJSIP_HEADERS is now
optional. If not specified, all header names will be
returned.
asterisk-org-access-app bot pushed a commit that referenced this issue Aug 14, 2023
@InterLinked1
res_pjsip_header_funcs: Make prefix argument optional.
2179082 
The documentation for PJSIP_HEADERS claims that
prefix is optional, but in the code it is actually not.
However, there is no inherent reason for this, as users
may want to retrieve all header names, not just those
beginning with a certain prefix.

This makes the prefix optional for this function,
simply fetching all header names if not specified.
As a result, the documentation is now correct.

Resolves: #230

UserNote: The prefix argument to PJSIP_HEADERS is now
optional. If not specified, all header names will be
returned.
asterisk-org-access-app bot pushed a commit that referenced this issue Aug 14, 2023
@InterLinked1 @asterisk-org-access-app
res_pjsip_header_funcs: Make prefix argument optional.
00070bc 
The documentation for PJSIP_HEADERS claims that
prefix is optional, but in the code it is actually not.
However, there is no inherent reason for this, as users
may want to retrieve all header names, not just those
beginning with a certain prefix.

This makes the prefix optional for this function,
simply fetching all header names if not specified.
As a result, the documentation is now correct.

Resolves: #230

UserNote: The prefix argument to PJSIP_HEADERS is now
optional. If not specified, all header names will be
returned.
asterisk-org-access-app bot pushed a commit that referenced this issue Sep 6, 2023
@InterLinked1 @asteriskteam
res_pjsip_header_funcs: Make prefix argument optional.
3442c05 
The documentation for PJSIP_HEADERS claims that
prefix is optional, but in the code it is actually not.
However, there is no inherent reason for this, as users
may want to retrieve all header names, not just those
beginning with a certain prefix.

This makes the prefix optional for this function,
simply fetching all header names if not specified.
As a result, the documentation is now correct.

Resolves: #230

UserNote: The prefix argument to PJSIP_HEADERS is now
optional. If not specified, all header names will be
returned.

(cherry picked from commit 08e7d77)
asterisk-org-access-app bot pushed a commit that referenced this issue Sep 6, 2023
@InterLinked1 @asteriskteam
res_pjsip_header_funcs: Make prefix argument optional.
9367926 
The documentation for PJSIP_HEADERS claims that
prefix is optional, but in the code it is actually not.
However, there is no inherent reason for this, as users
may want to retrieve all header names, not just those
beginning with a certain prefix.

This makes the prefix optional for this function,
simply fetching all header names if not specified.
As a result, the documentation is now correct.

Resolves: #230

UserNote: The prefix argument to PJSIP_HEADERS is now
optional. If not specified, all header names will be
returned.

(cherry picked from commit 8be503b)
asterisk-org-access-app bot pushed a commit that referenced this issue Sep 6, 2023
@InterLinked1 @asteriskteam
res_pjsip_header_funcs: Make prefix argument optional.
5069884 
The documentation for PJSIP_HEADERS claims that
prefix is optional, but in the code it is actually not.
However, there is no inherent reason for this, as users
may want to retrieve all header names, not just those
beginning with a certain prefix.

This makes the prefix optional for this function,
simply fetching all header names if not specified.
As a result, the documentation is now correct.

Resolves: #230

UserNote: The prefix argument to PJSIP_HEADERS is now
optional. If not specified, all header names will be
returned.

(cherry picked from commit 2179082)
asterisk-org-access-app bot pushed a commit that referenced this issue Sep 6, 2023
@InterLinked1 @asteriskteam
res_pjsip_header_funcs: Make prefix argument optional.
00d61df 
The documentation for PJSIP_HEADERS claims that
prefix is optional, but in the code it is actually not.
However, there is no inherent reason for this, as users
may want to retrieve all header names, not just those
beginning with a certain prefix.

This makes the prefix optional for this function,
simply fetching all header names if not specified.
As a result, the documentation is now correct.

Resolves: #230

UserNote: The prefix argument to PJSIP_HEADERS is now
optional. If not specified, all header names will be
returned.

(cherry picked from commit 2179082)
asterisk-org-access-app bot pushed a commit that referenced this issue Sep 6, 2023
@InterLinked1 @asteriskteam
res_pjsip_header_funcs: Make prefix argument optional.
c011914 
The documentation for PJSIP_HEADERS claims that
prefix is optional, but in the code it is actually not.
However, there is no inherent reason for this, as users
may want to retrieve all header names, not just those
beginning with a certain prefix.

This makes the prefix optional for this function,
simply fetching all header names if not specified.
As a result, the documentation is now correct.

Resolves: #230

UserNote: The prefix argument to PJSIP_HEADERS is now
optional. If not specified, all header names will be
returned.

(cherry picked from commit 2179082)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
bug support-level-core Functionality with core support level
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

res_pjsip_header_funcs: Make prefix argument optional. InterLinked1/asterisk
2 participants
@jcolp @alipsitz-sf