tyk icon indicating copy to clipboard operation
tyk copied to clipboard

[DX-1423] Update TYK_GW_SECRETS definition

Open dcs3spp opened this issue 8 months ago • 10 comments

DX-1423
Summary Reword TYK_GW_SECRETS config/environment variable
Type Bug Bug
Status In Progress
Points N/A
Labels -

User description

Description

This PR updates the config.go godoc comments in response to a ticket raised by @oluwaseyeayinla. It updates the description for TYK_GW_SECRETS with an example and explains what what can be be updated using the secrets://key notation.

Related Issue

https://tyktech.atlassian.net/browse/DX-1423

Motivation and Context

How This Has Been Tested

Screenshots (if appropriate)

Types of changes

  • [x] Bug fix (non-breaking change which fixes an issue)
  • [ ] New feature (non-breaking change which adds functionality)
  • [ ] Breaking change (fix or feature that would cause existing functionality to change)
  • [ ] Refactoring or add test (improvements in base code or adds test coverage to functionality)

Checklist

  • [x] I ensured that the documentation is up to date
  • [ ] I explained why this PR updates go.mod in detail with reasoning why it's required
  • [ ] I would like a code coverage CI quality gate exception and have explained why

PR Type

Documentation


Description

  • Updated the godoc comments for the TYK_GW_SECRETS environment variable in config/config.go.
  • Added a detailed explanation of the syntax and usage of TYK_GW_SECRETS.
  • Included an example to illustrate how the secrets can be used in the Tyk Gateway configuration.

Changes walkthrough 📝

Relevant files
Documentation
config.go
Update godoc comments for `TYK_GW_SECRETS` environment variable

config/config.go

  • Updated the godoc comments for the TYK_GW_SECRETS environment
    variable.
  • Added a detailed explanation of the syntax and usage of
    TYK_GW_SECRETS.
  • Included an example to illustrate how the secrets can be used in the
    Tyk Gateway configuration.
  • +12/-1   

    💡 PR-Agent usage: Comment /help on the PR to get a list of all available PR-Agent tools and their descriptions

    dcs3spp avatar Jun 19 '24 16:06 dcs3spp