Skip to content

bugfix: use the correct key when generating auth example in readme#19492

Merged
wing328 merged 1 commit intoOpenAPITools:masterfrom
chrisimcevoy:bugfix/19490-go-readme-example-api-key-map
Sep 2, 2024
Merged

bugfix: use the correct key when generating auth example in readme#19492
wing328 merged 1 commit intoOpenAPITools:masterfrom
chrisimcevoy:bugfix/19490-go-readme-example-api-key-map

Conversation

@chrisimcevoy
Copy link
Contributor

Generates a working example of api key auth in README.md.

cc @antihax @grokify @kemokemo @jirikuncar @ph4r5h4d @lwj5

closes #19490

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.

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.

[BUG][GO] API Key example usage in README.mustache uses incorrect map key

2 participants

Comments