Skip to content

[Python] Allow Overriding Accept Header#19025

Merged
wing328 merged 3 commits intoOpenAPITools:masterfrom
ckoegel:python-accept
Jun 28, 2024
Merged

[Python] Allow Overriding Accept Header#19025
wing328 merged 3 commits intoOpenAPITools:masterfrom
ckoegel:python-accept

Conversation

@ckoegel
Copy link
Contributor

@ckoegel ckoegel commented Jun 26, 2024

The Python SDK currently does not allow for overriding the Accept header at runtime. The header can be set using the _headers argument when calling an operation method, but this gets overwritten by the select_header_accept method called when the data is serialized to a request. This PR adds a conditional that skips the calling of the select_header_accept method if an Accept header has been provided by the user.

For example, calling

response = self.conferences_api_instance.download_conference_recording(
            'accountId, 'conferenceId', 'recordingId', _headers={'Accept': 'audio/vnd.wave'})

with

[
    'audio/vnd.wave', 
    'audio/mpeg', 
    'application/json'
]

as the list of accept headers being passed to the select_header_accept method, would previously set the Accept header to application/json but now respects the audio/vnd.wave passed in by the user.

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh ./bin/configs/*.yaml
    ./bin/utils/export_docs_generators.sh
    
    (For Windows users, please run the script in Git BASH)
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/java*.
    IMPORTANT: Do NOT purge/delete any folders/files (e.g. tests) when regenerating the samples as manually written tests may be removed.
  • File the PR against the correct branch: master (upcoming 7.6.0 minor release - breaking changes with fallbacks), 8.0.x (breaking changes without fallbacks)
  • If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.

@cbornet (2017/09) @tomplus (2018/10) @krjakbrjak (2023/02) @fa0311 (2023/10) @multani (2023/10)

@ckoegel ckoegel marked this pull request as ready for review June 26, 2024 19:38
@wing328
Copy link
Member

wing328 commented Jun 28, 2024

CI failure not related to this change

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants