Skip to content

Commit

Permalink
Merging to release-5.3.0: [TT-11185] release docs 5.3.0 update (#6079)
Browse files Browse the repository at this point in the history 
[TT-11185] release docs 5.3.0 update (#6079)

## This PR addresses feedback raised up in DX review.

- fixes typos
- removes oxford comma
- rewords some unclear docs
- adds docs
- consistent docs for `enabled` fields

Focuses on x-tyk-gateway.md docs (apidef/oas).


___

## **Type**
enhancement, documentation


___

## **Description**
- Updated comments across various structs for better clarity and
consistency.
- Changed phrasing from "Enabled enables" to "Enabled activates" to
improve readability.
- Enhanced documentation for authentication modes, middleware
configurations, operation structs, security configurations, server
configurations, upstream configurations, and URL rewriting.
- Added detailed examples and explanations where necessary to aid
understanding.


___



## **Changes walkthrough**
<table><thead><tr><th></th><th align="left">Relevant
files</th></tr></thead><tbody><tr><td><strong>Documentation</strong></td><td><table>
<tr>
  <td>
    <details>
<summary><strong>authentication.go</strong><dd><code>Improved
Authentication Structs Documentation and Clarity</code></dd></summary>
<hr>

apidef/oas/authentication.go
<li>Updated comments for clarity and consistency across authentication
<br>structs.<br> <li> Changed "Enabled enables" to "Enabled activates"
for various <br>authentication modes.<br> <li> Improved documentation
for HMAC, OIDC, CustomPluginAuthentication, and
<br>AuthenticationPlugin.


</details>
    

  </td>
<td><a
href="https://pull/6079/files#diff-e51c9d24d4235e7cc53048cc1d92967d177585ba5e073f14876308a97bef6326">+12/-10</a>&nbsp;
</td>
</tr>                    

<tr>
  <td>
    <details>
<summary><strong>middleware.go</strong><dd><code>Enhanced Middleware
Documentation and Consistency</code>&nbsp; &nbsp; &nbsp; &nbsp; &nbsp;
&nbsp; &nbsp; &nbsp; </dd></summary>
<hr>

apidef/oas/middleware.go
<li>Updated comments for clarity and consistency across middleware
<br>structs.<br> <li> Changed "Enabled enables" to "Enabled activates"
for various <br>middleware configurations.<br> <li> Added detailed
comments for <code>AllowedAlgorithms</code> in <code>HMAC</code> and
improved <br>documentation for custom plugins.


</details>
    

  </td>
<td><a
href="https://pull/6079/files#diff-992ec7c28d25fd54f6491d295389757705cd114bc869a35cba50d42e548cdc6e">+20/-16</a>&nbsp;
</td>
</tr>                    

<tr>
  <td>
    <details>
<summary><strong>operation.go</strong><dd><code>Refined Operation
Structs Documentation for Better Clarity</code></dd></summary>
<hr>

apidef/oas/operation.go
<li>Updated comments for clarity and consistency across operation
structs.<br> <li> Changed "Enabled enables" to "Enabled activates" for
mock response and <br>FromOASExamples.<br> <li> Improved documentation
for <code>MockResponse</code> and <code>FromOASExamples</code>.


</details>
    

  </td>
<td><a
href="https://pull/6079/files#diff-6d92d2d5b09a5fa7129609bb7cd0d383d015250ec07062b6a93a83257be51fb5">+3/-3</a>&nbsp;
&nbsp; &nbsp; </td>
</tr>                    

<tr>
  <td>
    <details>
<summary><strong>security.go</strong><dd><code>Updated Security Structs
Documentation for Enhanced Clarity</code></dd></summary>
<hr>

apidef/oas/security.go
<li>Updated comments for clarity and consistency across security
structs.<br> <li> Changed "Enabled enables" to "Enabled activates" for
token, basic <br>authentication, and OAuthProvider.<br> <li> Enhanced
documentation for <code>JWTValidation</code> and
<code>Introspection</code> structs.


</details>
    

  </td>
<td><a
href="https://pull/6079/files#diff-15e7d47137452ca4f3f6139aa8c007cdb426152c41846f712f8bf5dfb607afcc">+18/-11</a>&nbsp;
</td>
</tr>                    

<tr>
  <td>
    <details>
<summary><strong>server.go</strong><dd><code>Improved Server
Configuration Documentation and Consistency</code></dd></summary>
<hr>

apidef/oas/server.go
<li>Updated comments for clarity and consistency across server
<br>configuration structs.<br> <li> Changed "Enabled enables" to
"Enabled activates" for various server <br>configurations.<br> <li>
Improved documentation for <code>ListenPath</code>,
<code>ClientCertificates</code>, and <br><code>GatewayTags</code>.


</details>
    

  </td>
<td><a
href="https://pull/6079/files#diff-21857c42e8659f7980014e277c3c758703f29e9e5c0c40553f2584cddb870808">+9/-9</a>&nbsp;
&nbsp; &nbsp; </td>
</tr>                    

<tr>
  <td>
    <details>
<summary><strong>upstream.go</strong><dd><code>Enhanced Upstream
Configuration Documentation for Better
Understanding</code></dd></summary>
<hr>

apidef/oas/upstream.go
<li>Updated comments for clarity and consistency across upstream
<br>configuration structs.<br> <li> Changed "Enabled enables" to
"Enabled activates" for ServiceDiscovery <br>and MutualTLS.<br> <li>
Enhanced documentation for <code>RateLimit</code> and
<code>ServiceDiscoveryCache</code>.


</details>
    

  </td>
<td><a
href="https://pull/6079/files#diff-7b0941c7f37fe5a2a23047e0822a65519ca11c371660f36555b59a60f000e3f4">+6/-6</a>&nbsp;
&nbsp; &nbsp; </td>
</tr>                    

<tr>
  <td>
    <details>
<summary><strong>url_rewrite.go</strong><dd><code>Refined URL Rewrite
Documentation with Detailed Examples</code>&nbsp; </dd></summary>
<hr>

apidef/oas/url_rewrite.go
<li>Updated comments for clarity and consistency in URLRewrite
struct.<br> <li> Changed "Enabled enables" to "Enabled activates" for
URL rewriting.<br> <li> Added detailed examples and explanations for
<code>URLRewriteRule</code> fields.


</details>
    

  </td>
<td><a
href="https://pull/6079/files#diff-7317c6061fb6488e079d733230045c7cbc1b4b2ffb98bb7da20d4025f4976e51">+8/-4</a>&nbsp;
&nbsp; &nbsp; </td>
</tr>                    
</table></td></tr></tr></tbody></table>

___

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

---------

Co-authored-by: Tit Petric <tit@tyk.io>
  • Loading branch information
@buger
buger and Tit Petric committed Feb 28, 2024
1 parent 09ade6b commit 32e3e4d
Show file tree
Hide file tree
Showing 9 changed files with 83 additions and 66 deletions.
22 changes: 12 additions & 10 deletions apidef/oas/authentication.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -314,7 +314,7 @@ func (as *AuthSources) ExtractTo(authConfig *apidef.AuthConfig) {

// AuthSource defines an authentication source.
type AuthSource struct {
// Enabled enables the auth source.
// Enabled activates the auth source.
// Tyk classic API definition: `auth_configs[X].use_param/use_cookie`
Enabled bool `bson:"enabled" json:"enabled"` // required
// Name is the name of the auth source.
Expand Down Expand Up @@ -422,21 +422,23 @@ type ScopeToPolicy struct {

// HMAC holds the configuration for the HMAC authentication mode.
type HMAC struct {
// Enabled enables the HMAC authentication mode.
// Enabled activates the HMAC authentication mode.
// Tyk classic API definition: `enable_signature_checking`
Enabled bool `bson:"enabled" json:"enabled"` // required

// AuthSources contains authentication token source configuration (header, cookie, query).
AuthSources `bson:",inline" json:",inline"`

// AllowedAlgorithms is the array of HMAC algorithms which are allowed. Tyk supports the following HMAC algorithms:
// AllowedAlgorithms is the array of HMAC algorithms which are allowed.
//
// Tyk supports the following HMAC algorithms:
//
// - `hmac-sha1`
// - `hmac-sha256`
// - `hmac-sha384`
// - `hmac-sha512`
//
// and reads the value from algorithm header.
// and reads the value from the algorithm header.
//
// Tyk classic API definition: `hmac_allowed_algorithms`
AllowedAlgorithms []string `bson:"allowedAlgorithms,omitempty" json:"allowedAlgorithms,omitempty"`
Expand Down Expand Up @@ -476,7 +478,7 @@ func (h *HMAC) ExtractTo(api *apidef.APIDefinition) {

// OIDC contains configuration for the OIDC authentication mode.
type OIDC struct {
// Enabled enables the OIDC authentication mode.
// Enabled activates the OIDC authentication mode.
//
// Tyk classic API definition: `use_openid`
Enabled bool `bson:"enabled" json:"enabled"` // required
Expand All @@ -489,7 +491,7 @@ type OIDC struct {
// Tyk classic API definition: `openid_options.segregate_by_client`.
SegregateByClientId bool `bson:"segregateByClientId,omitempty" json:"segregateByClientId,omitempty"`

// Providers contains a list of authorised providers and their Client IDs, and matched policies.
// Providers contains a list of authorised providers, their Client IDs and matched policies.
//
// Tyk classic API definition: `openid_options.providers`.
Providers []Provider `bson:"providers,omitempty" json:"providers,omitempty"`
Expand Down Expand Up @@ -588,7 +590,7 @@ type ClientToPolicy struct {

// CustomPluginAuthentication holds configuration for custom plugins.
type CustomPluginAuthentication struct {
// Enabled enables the CustomPluginAuthentication authentication mode.
// Enabled activates the CustomPluginAuthentication authentication mode.
//
// Tyk classic API definition: `enable_coprocess_auth`/`use_go_plugin_auth`.
Enabled bool `bson:"enabled" json:"enabled"` // required
Expand Down Expand Up @@ -651,11 +653,11 @@ func (c *CustomPluginAuthentication) ExtractTo(api *apidef.APIDefinition) {

// AuthenticationPlugin holds the configuration for custom authentication plugin.
type AuthenticationPlugin struct {
// Enabled enables custom authentication plugin.
// Enabled activates custom authentication plugin.
Enabled bool `bson:"enabled" json:"enabled"` // required.
// FunctionName is the name of authentication method.
FunctionName string `bson:"functionName" json:"functionName"` // required.
// Path is the path to shared object file in case of gopluign mode or path to js code in case of otto auth plugin.
// Path is the path to shared object file in case of goplugin mode or path to JS code in case of otto auth plugin.
Path string `bson:"path" json:"path"`
// RawBodyOnly if set to true, do not fill body in request or response object.
RawBodyOnly bool `bson:"rawBodyOnly,omitempty" json:"rawBodyOnly,omitempty"`
Expand Down Expand Up @@ -758,7 +760,7 @@ func (id *IDExtractorConfig) ExtractTo(api *apidef.APIDefinition) {

// IDExtractor configures ID Extractor.
type IDExtractor struct {
// Enabled enables ID extractor with coprocess authentication.
// Enabled activates ID extractor with coprocess authentication.
Enabled bool `bson:"enabled" json:"enabled"` // required
// Source is the source from which ID to be extracted from.
Source apidef.IdExtractorSource `bson:"source" json:"source"` // required
Expand Down
38 changes: 21 additions & 17 deletions apidef/oas/middleware.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -277,7 +277,7 @@ func (g *Global) ExtractTo(api *apidef.APIDefinition) {

// PluginConfigData configures config data for custom plugins.
type PluginConfigData struct {
// Enabled enables custom plugin config data.
// Enabled activates custom plugin config data.
Enabled bool `bson:"enabled" json:"enabled"` // required.

// Value is the value of custom plugin config data.
Expand Down Expand Up @@ -365,7 +365,7 @@ func (p *PluginConfig) ExtractTo(api *apidef.APIDefinition) {

// PluginBundle holds configuration for custom plugins.
type PluginBundle struct {
// Enabled enables the custom plugin bundles.
// Enabled activates the custom plugin bundles.
//
// Tyk classic API definition: `custom_middleware_bundle_disabled`
Enabled bool `bson:"enabled" json:"enabled"` // required.
Expand Down Expand Up @@ -398,7 +398,7 @@ type CORS struct {
// Tyk classic API definition: `CORS.max_age`.
MaxAge int `bson:"maxAge,omitempty" json:"maxAge,omitempty"`

// AllowCredentials indicates whether the request can include user credentials like cookies,
// AllowCredentials indicates if the request can include user credentials like cookies,
// HTTP authentication or client side SSL certificates.
//
// Tyk classic API definition: `CORS.allow_credentials`.
Expand Down Expand Up @@ -885,7 +885,7 @@ type Header struct {

// TransformRequestMethod holds configuration for rewriting request methods.
type TransformRequestMethod struct {
// Enabled enables Method Transform for the given path and method.
// Enabled activates Method Transform for the given path and method.
Enabled bool `bson:"enabled" json:"enabled"`
// ToMethod is the http method value to which the method of an incoming request will be transformed.
ToMethod string `bson:"toMethod" json:"toMethod"`
Expand All @@ -905,7 +905,7 @@ func (tm *TransformRequestMethod) ExtractTo(meta *apidef.MethodTransformMeta) {

// TransformBody holds configuration about request/response body transformations.
type TransformBody struct {
// Enabled enables transform request/request body middleware.
// Enabled activates transform request/request body middleware.
Enabled bool `bson:"enabled" json:"enabled"`
// Format of the request/response body, xml or json.
Format apidef.RequestInputType `bson:"format" json:"format"`
Expand Down Expand Up @@ -942,7 +942,7 @@ func (tr *TransformBody) ExtractTo(meta *apidef.TemplateMeta) {

// TransformHeaders holds configuration about request/response header transformations.
type TransformHeaders struct {
// Enabled enables Header Transform for the given path and method.
// Enabled activates Header Transform for the given path and method.
Enabled bool `bson:"enabled" json:"enabled"`
// Remove specifies header names to be removed from the request/response.
Remove []string `bson:"remove,omitempty" json:"remove,omitempty"`
Expand Down Expand Up @@ -1038,11 +1038,11 @@ func (et *EnforceTimeout) ExtractTo(meta *apidef.HardTimeoutMeta) {

// CustomPlugin configures custom plugin.
type CustomPlugin struct {
// Enabled enables the custom pre plugin.
// Enabled activates the custom pre plugin.
Enabled bool `bson:"enabled" json:"enabled"` // required.
// FunctionName is the name of authentication method.
FunctionName string `bson:"functionName" json:"functionName"` // required.
// Path is the path to shared object file in case of gopluign mode or path to js code in case of otto auth plugin.
// Path is the path to shared object file in case of goplugin mode or path to JS code in case of otto auth plugin.
Path string `bson:"path" json:"path"`
// RawBodyOnly if set to true, do not fill body in request or response object.
RawBodyOnly bool `bson:"rawBodyOnly,omitempty" json:"rawBodyOnly,omitempty"`
Expand All @@ -1051,7 +1051,7 @@ type CustomPlugin struct {
RequireSession bool `bson:"requireSession,omitempty" json:"requireSession,omitempty"`
}

// CustomPlugins is a list of CustomPlugin.
// CustomPlugins is a list of CustomPlugin objects.
type CustomPlugins []CustomPlugin

// Fill fills CustomPlugins from supplied Middleware definitions.
Expand Down Expand Up @@ -1080,7 +1080,11 @@ func (c CustomPlugins) ExtractTo(mwDefs []apidef.MiddlewareDefinition) {
}
}

// PrePlugin configures pre stage plugins.
// PrePlugin configures pre-request plugins.
//
// Pre-request plugins are executed before the request is sent to the
// upstream target and before any authentication information is extracted
// from the header or parameter list of the request.
type PrePlugin struct {
// Plugins configures custom plugins to be run on pre authentication stage.
// The plugins would be executed in the order of configuration in the list.
Expand Down Expand Up @@ -1198,13 +1202,13 @@ func (p *ResponsePlugin) ExtractTo(api *apidef.APIDefinition) {

// VirtualEndpoint contains virtual endpoint configuration.
type VirtualEndpoint struct {
// Enabled enables virtual endpoint.
// Enabled activates virtual endpoint.
Enabled bool `bson:"enabled" json:"enabled"` // required.
// Name is the name of js function.
// Name is the name of JS function.
Name string `bson:"name" json:"name"` // required.
// Path is the path to js file.
// Path is the path to JS file.
Path string `bson:"path,omitempty" json:"path,omitempty"`
// Body is the js function to execute encoded in base64 format.
// Body is the JS function to execute encoded in base64 format.
Body string `bson:"body,omitempty" json:"body,omitempty"`
// ProxyOnError proxies if virtual endpoint errors out.
ProxyOnError bool `bson:"proxyOnError,omitempty" json:"proxyOnError,omitempty"`
Expand Down Expand Up @@ -1244,7 +1248,7 @@ type EndpointPostPlugins []EndpointPostPlugin

// EndpointPostPlugin contains endpoint level post plugin configuration.
type EndpointPostPlugin struct {
// Enabled enables post plugin.
// Enabled activates post plugin.
Enabled bool `bson:"enabled" json:"enabled"` // required.
// Name is the name of plugin function to be executed.
Name string `bson:"name" json:"name"` // required.
Expand Down Expand Up @@ -1279,7 +1283,7 @@ func (e EndpointPostPlugins) ExtractTo(meta *apidef.GoPluginMeta) {
// CircuitBreaker holds configuration for the circuit breaker middleware.
// Tyk classic API definition: `version_data.versions..extended_paths.circuit_breakers[*]`.
type CircuitBreaker struct {
// Enabled enables the Circuit Breaker functionality.
// Enabled activates the Circuit Breaker functionality.
// Tyk classic API definition: `version_data.versions..extended_paths.circuit_breakers[*].disabled`.
Enabled bool `bson:"enabled" json:"enabled"`
// Threshold is the proportion from each `sampleSize` requests that must fail for the breaker to be tripped. This must be a value between 0.0 and 1.0. If `sampleSize` is 100 then a threshold of 0.4 means that the breaker will be tripped if 40 out of every 100 requests fails.
Expand Down Expand Up @@ -1316,7 +1320,7 @@ func (cb *CircuitBreaker) ExtractTo(circuitBreaker *apidef.CircuitBreakerMeta) {

// RequestSizeLimit limits the maximum allowed size of the request body in bytes.
type RequestSizeLimit struct {
// Enabled enables the Request Size Limit functionality.
// Enabled activates the Request Size Limit functionality.
Enabled bool `bson:"enabled" json:"enabled"`
// Value is the maximum allowed size of the request body in bytes.
Value int64 `bson:"value" json:"value"`
Expand Down
2 changes: 1 addition & 1 deletion apidef/oas/oasutil.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ import (
"reflect"
)

// ShouldOmit checks whether a field should be set to empty and omitted from OAS JSON.
// ShouldOmit checks if a field should be set to empty and omitted from OAS JSON.
func ShouldOmit(i interface{}) bool {
return IsZero(reflect.ValueOf(i))
}
Expand Down
6 changes: 3 additions & 3 deletions apidef/oas/operation.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -711,7 +711,7 @@ func (s *OAS) fillOASValidateRequest(metas []apidef.ValidatePathMeta) {

// MockResponse configures the mock responses.
type MockResponse struct {
// Enabled enables the mock response middleware.
// Enabled activates the mock response middleware.
Enabled bool `bson:"enabled" json:"enabled"`
// Code is the HTTP response code that will be returned.
Code int `bson:"code,omitempty" json:"code,omitempty"`
Expand All @@ -723,9 +723,9 @@ type MockResponse struct {
FromOASExamples *FromOASExamples `bson:"fromOASExamples,omitempty" json:"fromOASExamples,omitempty"`
}

// FromOASExamples configures mock responses should be returned from OAS example responses.
// FromOASExamples configures mock responses that should be returned from OAS example responses.
type FromOASExamples struct {
// Enabled enables getting a mock response from OAS examples or schemas documented in OAS.
// Enabled activates getting a mock response from OAS examples or schemas documented in OAS.
Enabled bool `bson:"enabled" json:"enabled"`
// Code is the default HTTP response code that the gateway reads from the path responses documented in OAS.
Code int `bson:"code,omitempty" json:"code,omitempty"`
Expand Down
2 changes: 1 addition & 1 deletion apidef/oas/root.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ func (i *Info) ExtractTo(api *apidef.APIDefinition) {
}
}

// State holds configuration for the status of the API within Tyk - whether it is currently active and whether it is exposed externally.
// State holds configuration for the status of the API within Tyk - if it is currently active and if it is exposed externally.
type State struct {
// Active enables the API so that Tyk will listen for and process requests made to the listenPath.
// Tyk classic API definition: `active`
Expand Down
29 changes: 18 additions & 11 deletions apidef/oas/security.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ const (

// Token holds the values related to authentication tokens.
type Token struct {
// Enabled enables the token based authentication mode.
// Enabled activates the token based authentication mode.
//
// Tyk classic API definition: `auth_configs["authToken"].use_standard_auth`
Enabled bool `bson:"enabled" json:"enabled"` // required
Expand Down Expand Up @@ -207,7 +207,7 @@ func (s *OAS) extractJWTTo(api *apidef.APIDefinition, name string) {

// Basic type holds configuration values related to http basic authentication.
type Basic struct {
// Enabled enables the basic authentication mode.
// Enabled activates the basic authentication mode.
// Tyk classic API definition: `use_basic_auth`
Enabled bool `bson:"enabled" json:"enabled"` // required
AuthSources `bson:",inline" json:",inline"`
Expand Down Expand Up @@ -296,7 +296,7 @@ func (s *OAS) extractBasicTo(api *apidef.APIDefinition, name string) {

// ExtractCredentialsFromBody configures extracting credentials from the request body.
type ExtractCredentialsFromBody struct {
// Enabled enables extracting credentials from body.
// Enabled activates extracting credentials from body.
// Tyk classic API definition: `basic_auth.extract_from_body`
Enabled bool `bson:"enabled" json:"enabled"` // required
// UserRegexp is the regex for username e.g. `<User>(.*)</User>`.
Expand Down Expand Up @@ -407,22 +407,29 @@ type OAuthProvider struct {
}

type JWTValidation struct {
// Enabled enables OAuth access token validation by introspection to a third party.
// Enabled activates OAuth access token validation by introspection to a third party.
Enabled bool `bson:"enabled" json:"enabled"`

// SigningMethod to verify signing method used in jwt - allowed values HMAC/RSA/ECDSA.
SigningMethod string `bson:"signingMethod" json:"signingMethod"`
// Source is the secret to verify signature, it could be one among:

// Source is the secret to verify signature. Valid values are:
//
// - a base64 encoded static secret,
// - a valid JWK URL in plain text,
// - a valid JWK URL in base64 encoded format.
Source string `bson:"source" json:"source"`

// IdentityBaseField is the identity claim name.
IdentityBaseField string `bson:"identityBaseField,omitempty" json:"identityBaseField,omitempty"`
// IssuedAtValidationSkew is the clock skew to be considered while validating iat claim.

// IssuedAtValidationSkew is the clock skew to be considered while validating the iat claim.
IssuedAtValidationSkew uint64 `bson:"issuedAtValidationSkew,omitempty" json:"issuedAtValidationSkew,omitempty"`
// NotBeforeValidationSkew is the clock skew to be considered while validating nbf claim.

// NotBeforeValidationSkew is the clock skew to be considered while validating the nbf claim.
NotBeforeValidationSkew uint64 `bson:"notBeforeValidationSkew,omitempty" json:"notBeforeValidationSkew,omitempty"`
// ExpiresAtValidationSkew is the clock skew to be considered while validating exp claim.

// ExpiresAtValidationSkew is the clock skew to be considered while validating the exp claim.
ExpiresAtValidationSkew uint64 `bson:"expiresAtValidationSkew,omitempty" json:"expiresAtValidationSkew,omitempty"`
}

Expand All @@ -447,13 +454,13 @@ func (j *JWTValidation) ExtractTo(jwt *apidef.JWTValidation) {
}

type Introspection struct {
// Enabled enables OAuth access token validation by introspection to a third party.
// Enabled activates OAuth access token validation by introspection to a third party.
Enabled bool `bson:"enabled" json:"enabled"`
// URL is the URL of the third party provider's introspection endpoint.
URL string `bson:"url" json:"url"`
// ClientID is the public identifier for the client, acquired from the third party.
ClientID string `bson:"clientId" json:"clientId"`
// ClientSecret is a secret known only to the client and the authorization server, acquired from the third party.
// ClientSecret is a secret known only to the client and the authorisation server, acquired from the third party.
ClientSecret string `bson:"clientSecret" json:"clientSecret"`
// IdentityBaseField is the key showing where to find the user id in the claims. If it is empty, the `sub` key is looked at.
IdentityBaseField string `bson:"identityBaseField,omitempty" json:"identityBaseField,omitempty"`
Expand Down Expand Up @@ -491,7 +498,7 @@ func (i *Introspection) ExtractTo(intros *apidef.Introspection) {
}

type IntrospectionCache struct {
// Enabled enables the caching mechanism for introspection responses.
// Enabled activates the caching mechanism for introspection responses.
Enabled bool `bson:"enabled" json:"enabled"`
// Timeout is the duration in seconds of how long the cached value stays.
// For introspection caching, it is suggested to use a short interval.
Expand Down
Loading

0 comments on commit 32e3e4d

Please sign in to comment.