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.

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

Authentication headers in Mojo and CLI 'validate' command #20644

Conversation

SimoneDalka
Copy link
Contributor

@SimoneDalka SimoneDalka commented Feb 11, 2025

This PR adds authentication headers (if any) when fetching the OpenAPI definitions remotely.

Changes have been made on:

  • validate command of openapi-generator-cli
  • calculateInputSpecHash method in CodeGenMojo.java
  • createCollapsedSpec method in CodeGenMojo.java

Resolves #19308, resolves #19108

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 || exit
    ./bin/generate-samples.sh ./bin/configs/*.yaml || exit
    ./bin/utils/export_docs_generators.sh || exit
    
    (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.x.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.

cc: @bbdouglas @sreeshas @jfiala @lukoyanov @cbornet @jeff9finger @karismann @Zomzog @lwlee2608 @martin-mfg

@SimoneDalka SimoneDalka changed the title fix #19308 Authentication headers in Mojo and CLI 'validate' command Feb 11, 2025
description = "adds authorization headers when fetching the OpenAPI definitions remotely. "
+ "Pass in a URL-encoded string of name:header with a comma separating multiple values")
private String auth;

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks for the PR

looks like this is the same as --auth option for generate

@Option(
name = {"-a", "--auth"},
title = "authorization",
description = "adds authorization headers when fetching the OpenAPI definitions remotely. "
+ "Pass in a URL-encoded string of name:header with a comma separating multiple values")
private String auth;

@wing328
Copy link
Member

wing328 commented Mar 2, 2025

cc @OpenAPITools/generator-core-team

@wing328
Copy link
Member

wing328 commented Mar 2, 2025

thanks for the PR

let's give it a try

@wing328 wing328 merged commit 70df117 into OpenAPITools:master Mar 2, 2025
16 checks passed
JacobOJ pushed a commit to JacobOJ/openapi-generator that referenced this pull request Mar 3, 2025
kpy3 pushed a commit to kpy3/openapi-generator that referenced this pull request Mar 13, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants