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

docs: add api key auth instructions #5097

Merged
merged 2 commits into from
Jan 27, 2025
Merged

Conversation

nothinux
Copy link
Contributor

What type of PR is this?

  • docs: add api key auth instructions

What this PR does / why we need it:

Which issue(s) this PR fixes:

Fixes #5047

@nothinux nothinux requested a review from a team as a code owner January 19, 2025 13:26
Signed-off-by: Taufik Mulyana <[email protected]>
Copy link

codecov bot commented Jan 19, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 66.89%. Comparing base (a1e2022) to head (1e016f6).
Report is 38 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5097      +/-   ##
==========================================
+ Coverage   66.80%   66.89%   +0.09%     
==========================================
  Files         210      210              
  Lines       32953    32953              
==========================================
+ Hits        22013    22043      +30     
+ Misses       9603     9580      -23     
+ Partials     1337     1330       -7     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

Copy link
Contributor

@arkodg arkodg left a comment

Choose a reason for hiding this comment

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

LGTM thanks !

@arkodg arkodg requested review from a team January 24, 2025 19:13
@arkodg arkodg added this to the v1.3.0 milestone Jan 24, 2025
@arkodg arkodg merged commit b5cf087 into envoyproxy:main Jan 27, 2025
26 of 28 checks passed
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add api key auth instruction

Signed-off-by: Taufik Mulyana <[email protected]>

* fix: remove unrelated links

Signed-off-by: Taufik Mulyana <[email protected]>

---------

Signed-off-by: Taufik Mulyana <[email protected]>
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add api key auth instruction

Signed-off-by: Taufik Mulyana <[email protected]>

* fix: remove unrelated links

Signed-off-by: Taufik Mulyana <[email protected]>

---------

Signed-off-by: Taufik Mulyana <[email protected]>
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add api key auth instruction

Signed-off-by: Taufik Mulyana <[email protected]>

* fix: remove unrelated links

Signed-off-by: Taufik Mulyana <[email protected]>

---------

Signed-off-by: Taufik Mulyana <[email protected]>
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add api key auth instruction

Signed-off-by: Taufik Mulyana <[email protected]>

* fix: remove unrelated links

Signed-off-by: Taufik Mulyana <[email protected]>

---------

Signed-off-by: Taufik Mulyana <[email protected]>
(cherry picked from commit b5cf087)
Signed-off-by: Guy Daich <[email protected]>
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add api key auth instruction

Signed-off-by: Taufik Mulyana <[email protected]>

* fix: remove unrelated links

Signed-off-by: Taufik Mulyana <[email protected]>

---------

Signed-off-by: Taufik Mulyana <[email protected]>
(cherry picked from commit b5cf087)
Signed-off-by: Guy Daich <[email protected]>
guydc pushed a commit to guydc/gateway that referenced this pull request Jan 31, 2025
* docs: add api key auth instruction

Signed-off-by: Taufik Mulyana <[email protected]>

* fix: remove unrelated links

Signed-off-by: Taufik Mulyana <[email protected]>

---------

Signed-off-by: Taufik Mulyana <[email protected]>
(cherry picked from commit b5cf087)
Signed-off-by: Guy Daich <[email protected]>
guydc added a commit that referenced this pull request Jan 31, 2025
* doc: response compression (#5071)

compression docs

Signed-off-by: Huabing Zhao <[email protected]>
(cherry picked from commit 549fdde)
Signed-off-by: Guy Daich <[email protected]>

* docs: how to specify a self-signed ca for the remote jwks host in the SP JWT settings. (#5085)

* docs for jwt self-signed ca

Signed-off-by: Huabing Zhao <[email protected]>

* fix gen

Signed-off-by: Huabing Zhao <[email protected]>

* update docs

Signed-off-by: Huabing Zhao <[email protected]>

---------

Signed-off-by: Huabing Zhao <[email protected]>
(cherry picked from commit fdc7849)
Signed-off-by: Guy Daich <[email protected]>

* chore: fix gen (#5166)

fix gen

Signed-off-by: Huabing (Robin) Zhao <[email protected]>
(cherry picked from commit 34db8af)
Signed-off-by: Guy Daich <[email protected]>

* docs: add api key auth instructions (#5097)

* docs: add api key auth instruction

Signed-off-by: Taufik Mulyana <[email protected]>

* fix: remove unrelated links

Signed-off-by: Taufik Mulyana <[email protected]>

---------

Signed-off-by: Taufik Mulyana <[email protected]>
(cherry picked from commit b5cf087)
Signed-off-by: Guy Daich <[email protected]>

* add SECURITY.md (#5167)

Signed-off-by: Arko Dasgupta <[email protected]>
(cherry picked from commit f7a10eb)
Signed-off-by: Guy Daich <[email protected]>

* chore: link SECURITY.md (#5168)

Signed-off-by: Arko Dasgupta <[email protected]>
(cherry picked from commit ac9026f)
Signed-off-by: Guy Daich <[email protected]>

* build(deps): bump actions/stale from 9.0.0 to 9.1.0 (#5162)

Bumps [actions/stale](https://github.com/actions/stale) from 9.0.0 to 9.1.0.
- [Release notes](https://github.com/actions/stale/releases)
- [Changelog](https://github.com/actions/stale/blob/main/CHANGELOG.md)
- [Commits](actions/stale@28ca103...5bef64f)

---
updated-dependencies:
- dependency-name: actions/stale
  dependency-type: direct:production
  update-type: version-update:semver-minor
...

Signed-off-by: dependabot[bot] <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: Arko Dasgupta <[email protected]>
(cherry picked from commit 57d4aa8)
Signed-off-by: Guy Daich <[email protected]>

* docs: rm sectionName from some of the examples (#5173)

adds whats left off from #4868

deleted the sectionName in these examples because the Service spec does
not define a port `Name`

Signed-off-by: Arko Dasgupta <[email protected]>
(cherry picked from commit 45804e2)
Signed-off-by: Guy Daich <[email protected]>

* ci(fix): osv-scanner PR mode (#5174)

fix: osv-scanner PR mode

Signed-off-by: shahar-h <[email protected]>
Co-authored-by: Guy Daich <[email protected]>
(cherry picked from commit e904d3f)
Signed-off-by: Guy Daich <[email protected]>

* wip: docs: add standalone in container instruction (#5172)

* docs: add standalone in container instruction

Signed-off-by: Denis Shatokhin <[email protected]>

* docs: update headings and image tag

Signed-off-by: Denis Shatokhin <[email protected]>

---------

Signed-off-by: Denis Shatokhin <[email protected]>
(cherry picked from commit a3448c1)
Signed-off-by: Guy Daich <[email protected]>

* docs: update prerequisites files with installation and connectivity t… (#5094)

* docs: update prerequisites files with installation and connectivity testing steps

Signed-off-by: DeeBi9 <[email protected]>

* lint

Signed-off-by: DeeBi9 <[email protected]>

* docs: remove the Note

Signed-off-by: DeeBi9 <[email protected]>

* remove redundant code

Signed-off-by: DeeBi9 <[email protected]>

---------

Signed-off-by: DeeBi9 <[email protected]>
(cherry picked from commit 3253339)
Signed-off-by: Guy Daich <[email protected]>

* [release/v1.3] fix 1.3.0-rc.1 release note (#5175)

* fix 1.3.0-rc.1 release note

Signed-off-by: Guy Daich <[email protected]>

* more fixes

Signed-off-by: Guy Daich <[email protected]>

---------

Signed-off-by: Guy Daich <[email protected]>
(cherry picked from commit 4fba2bf)
Signed-off-by: Guy Daich <[email protected]>

* fail validation if baseInterval is 0s (#5176)

* fail validation if baseInterval is 0s

Fixes: #5147

Signed-off-by: Arko Dasgupta <[email protected]>

* more validations

Signed-off-by: Arko Dasgupta <[email protected]>

---------

Signed-off-by: Arko Dasgupta <[email protected]>
(cherry picked from commit 4844d9a)
Signed-off-by: Guy Daich <[email protected]>

* [release/1.3] release notes (#5177)

Signed-off-by: Guy Daich <[email protected]>
(cherry picked from commit c2215b2)
Signed-off-by: Guy Daich <[email protected]>

---------

Signed-off-by: Huabing Zhao <[email protected]>
Signed-off-by: Guy Daich <[email protected]>
Signed-off-by: Huabing (Robin) Zhao <[email protected]>
Signed-off-by: Taufik Mulyana <[email protected]>
Signed-off-by: Arko Dasgupta <[email protected]>
Signed-off-by: dependabot[bot] <[email protected]>
Signed-off-by: shahar-h <[email protected]>
Signed-off-by: Denis Shatokhin <[email protected]>
Signed-off-by: DeeBi9 <[email protected]>
Co-authored-by: Huabing (Robin) Zhao <[email protected]>
Co-authored-by: Taufik Mulyana <[email protected]>
Co-authored-by: Arko Dasgupta <[email protected]>
Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Co-authored-by: shahar-h <[email protected]>
Co-authored-by: Denis Shatokhin <[email protected]>
Co-authored-by: Deepanshu Bisht <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

docs: API Key Auth
3 participants