Skip to content
GitLab
Projects Groups Snippets
  • /
  • Help
    • Help
    • Support
    • Community forum
    • Submit feedback
    • Contribute to GitLab
  • Sign in / Register
  • O openapi-generator
  • Project information
    • Project information
    • Activity
    • Labels
    • Members
  • Repository
    • Repository
    • Files
    • Commits
    • Branches
    • Tags
    • Contributors
    • Graph
    • Compare
  • Issues 3,476
    • Issues 3,476
    • List
    • Boards
    • Service Desk
    • Milestones
  • Merge requests 402
    • Merge requests 402
  • CI/CD
    • CI/CD
    • Pipelines
    • Jobs
    • Schedules
  • Deployments
    • Deployments
    • Environments
    • Releases
  • Packages and registries
    • Packages and registries
    • Package Registry
    • Infrastructure Registry
  • Monitor
    • Monitor
    • Incidents
  • Analytics
    • Analytics
    • Value stream
    • CI/CD
    • Repository
  • Wiki
    • Wiki
  • Snippets
    • Snippets
  • Activity
  • Graph
  • Create a new issue
  • Jobs
  • Commits
  • Issue Boards
Collapse sidebar
  • OpenAPI Tools
  • openapi-generator
  • Merge requests
  • !13321

[swift5] distinguish (un-)authenticated requests

  • Review changes

  • Download
  • Email patches
  • Plain diff
Merged Administrator requested to merge github/fork/Jonas1893/feat/authenticated-request-builders into master Aug 31, 2022
  • Overview 6
  • Commits 3
  • Pipelines 0
  • Changes 118

Created by: Jonas1893

Summary

This adds the ability to easily distinguish between endpoints that should be requested authenticated and those that should be requested unauthenticated.

Motivation

Currently the intended way of authentication according to the FAQs is to implement a custom RequestBuilder overriding execute (URLSession) or to inject a custom RequestInterceptor (AF library). The drawback here is that the information from the swagger spec (via the security scheme annotation), whether an endpoint needs to be requested authenticated or not is not available anymore at this level in the code. There were discussion on how to handle this properly but without definite outcome. Currently, it is necessary to maintain a whitelist of requests that need to be requested (un-)authenticated in the app logic.

Changes in this PR

This PR adds a new property to RequestBuilder to distinguish (un-)authenticated requests. It is now possible to decide in RequestBuilder logic how to handle authentication (like e.g. adapting request with a token or not)

Other effects

  • The FAQs and linked sample codes would need to be adopted as well

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/utils/export_docs_generators.sh
    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*. For Windows users, please run the script in Git BASH.
  • File the PR against the correct branch: master (6.1.0) (minor release - breaking changes with fallbacks), 7.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. -> @4brunu this is the alternative approach we discussed in #13318

Declaration

The program was tested solely for our own use cases, which might differ from yours.

Link to provider information

https://github.com/mercedes-benz

Assignee
Assign to
Reviewers
Request review from
Time tracking
Source branch: github/fork/Jonas1893/feat/authenticated-request-builders