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

API Key Auth Policy Docs #5752

Merged
merged 9 commits into from
Jun 17, 2024
Merged

API Key Auth Policy Docs #5752

merged 9 commits into from
Jun 17, 2024

Conversation

j1m-ryan
Copy link
Member

Proposed changes

Docs for #5580
Does not include the example folder docs as those are in the main PR

Checklist

Before creating a PR, run through this checklist and mark each as complete.

  • I have read the CONTRIBUTING doc
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that all unit tests pass after adding my changes
  • I have updated necessary documentation
  • I have rebased my branch onto main
  • I will ensure my PR is targeting the main branch and pulling from my branch from my own fork

@j1m-ryan j1m-ryan requested review from a team as code owners June 14, 2024 08:07
@github-actions github-actions bot added the documentation Pull requests/issues for documentation label Jun 14, 2024
ADubhlaoich
ADubhlaoich reviewed Jun 14, 2024
View reviewed changes
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

LGTM though this document was updated yesterday, so you may want to merge changes from main.

It includes the proper formatting for tables and notes, which this new section doesn't adhere to.

ADubhlaoich
ADubhlaoich approved these changes Jun 14, 2024
View reviewed changes
Copy link
Contributor

@ADubhlaoich ADubhlaoich left a comment

Choose a reason for hiding this comment

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

Forgot to hit the approve option...

@j1m-ryan j1m-ryan merged commit a497503 into main Jun 17, 2024
28 checks passed
@j1m-ryan j1m-ryan deleted the docs/api-key branch June 17, 2024 11:11
pdabelf5 pushed a commit that referenced this pull request Jun 17, 2024
@j1m-ryan @pdabelf5
API Key Auth Policy Docs (#5752)
45d455e 
* add API Key to top list of policies

* add api key docs

* fix typo

* add detail the api keys are base64 encoded in the secret

* add clarification to merging behaviour
ssrahul96 pushed a commit to ssrahul96/kubernetes-ingress that referenced this pull request Jun 20, 2024
@j1m-ryan @ssrahul96
API Key Auth Policy Docs (nginxinc#5752)
c5b91bd 
* add API Key to top list of policies

* add api key docs

* fix typo

* add detail the api keys are base64 encoded in the secret

* add clarification to merging behaviour
This was referenced Jul 1, 2024
Closed
Closed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@ADubhlaoich ADubhlaoich ADubhlaoich approved these changes

@oseoin oseoin oseoin approved these changes

Assignees
No one assigned
Labels
documentation Pull requests/issues for documentation
Projects
NGINX Ingress Controller
Status: Done 🚀
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@j1m-ryan @ADubhlaoich @oseoin