@zuplo/runtime 5.1583.0 → 5.1585.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +6 -4
  2. package/package.json +1 -1
package/index.d.ts CHANGED
@@ -99,6 +99,7 @@ declare interface AmberfloMeteringProperties extends Omit<AmberfloMeteringIngest
99
99
  *
100
100
  * @title API Key Authentication
101
101
  * @public
102
+ * @unlisted
102
103
  * @param request - The ZuploRequest
103
104
  * @param context - The ZuploContext
104
105
  * @param unparsedOptions - The policy options set in policies.json
@@ -129,8 +130,8 @@ export declare interface ApiAuthKeyInboundPolicyOptions {
129
130
  * For more information on Zuplo's API Key Management service and options enabling
130
131
  * self-serve API Key management see the following resources:
131
132
  *
132
- * @see {@link https://zuplo.com/docs/articles/api-key-management|API Key Authentication Overview}
133
- * @see {@link https://zuplo.com/docs/articles/api-key-api|API Key Management API}
133
+ * - {@link https://zuplo.com/docs/articles/api-key-management|API Key Authentication Overview}
134
+ * - {@link https://zuplo.com/docs/articles/api-key-api|API Key Management API}
134
135
  *
135
136
  * @title API Key Authentication
136
137
  * @public
@@ -3707,7 +3708,7 @@ export declare const UpstreamGcpJwtInboundPolicy: InboundPolicyHandler<UpstreamG
3707
3708
  */
3708
3709
  export declare interface UpstreamGcpJwtInboundPolicyOptions {
3709
3710
  /**
3710
- * The audience for the minted JWT. Refer to https://cloud.google.com/endpoints/docs/grpc-service-config/reference/rpc/google.api#google.api.AuthRequirement.
3711
+ * The audience for the minted JWT. See the document {@link https://cloud.google.com/endpoints/docs/grpc-service-config/reference/rpc/google.api#google.api.AuthRequirement|AuthRequirement} for details.
3711
3712
  */
3712
3713
  audience: string;
3713
3714
  /**
@@ -3718,7 +3719,6 @@ export declare interface UpstreamGcpJwtInboundPolicyOptions {
3718
3719
 
3719
3720
  /**
3720
3721
  * Creates an ID Token from Google's OAuth service and attaches it to the outgoing request. Useful when calling GCP services that are secured with GCP IAM.
3721
- * @see {@link https://cloud.google.com/functions/docs/securing/authenticating|Authenticating for invocation}
3722
3722
  *
3723
3723
  * @remarks
3724
3724
  * This policy allows you to delegate authentication and authorization to your
@@ -3735,6 +3735,8 @@ export declare interface UpstreamGcpJwtInboundPolicyOptions {
3735
3735
  * We recommend reading the `serviceAccountJson` from environment variables (so it
3736
3736
  * is not checked in to source control) using the `$env(ENV_VAR)` syntax.
3737
3737
  *
3738
+ * For information on how Google's service based auth works see {@link https://cloud.google.com/functions/docs/securing/authenticating|Authenticating for invocation}
3739
+ *
3738
3740
  * @title Upstream GCP Service Auth
3739
3741
  * @public
3740
3742
  * @param request - The ZuploRequest
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@zuplo/runtime",
3
- "version": "5.1583.0",
3
+ "version": "5.1585.0",
4
4
  "repository": "https://github.com/zuplo/zuplo",
5
5
  "author": "Zuplo, Inc.",
6
6
  "exports": {