@dynatrace-sdk/client-app-engine-edge-connect - npm Package Compare versions

Comparing version 1.2.3 to 1.2.5

CHANGELOG.md

@@ -5,2 +5,12 @@ # AppEngine - EdgeConnect
 
+## 1.2.5
+
+### Patch Changes
+
+- Fix broken links in the readme file.
+
+## 1.2.4
+
+- Fix inconsistencies in OpenaAPI spec between SDK and API.
+
 ## 1.2.3
@@ -7,0 +17,0 @@

cjs/index.js

@@ -579,2 +579,7 @@ /**
   httpClient;
+  /**
+   * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a EdgeConnectClient. Custom http client should implement {HttpClient} interface.
+   * @example
+   * const edgeConnectClientNodeJs = new EdgeConnectClient(yourCustomImplementation);
+   */
   constructor(httpClientImplementation) {
@@ -584,2 +589,14 @@ this.httpClient = httpClientImplementation;
   }
+  /**
+   * List all EdgeConnects
+   *
+   * **Required scope:** app-engine:edge-connects:read
+   *
+   * @returns A list of all EdgeConnects
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.listEdgeConnects();
+   */
   async listEdgeConnects(config = {}) {
@@ -637,2 +654,29 @@ if (!config) {
   }
+  /**
+   * Create a new EdgeConnect.
+   *
+   * **Required scope:** app-engine:edge-connects:write<br/><br/>You can either specify a UUID in the request body or a random UUID
+   * will be assigned to the created EdgeConnect configuration.
+   *
+   * The name must not be longer than 50 characters and must be 'RFC 1123' compliant. The OAuth client ID is optional.
+   * If no OAuth client ID is provided an OAuth client must be generated for that EdgeConnect. This additionally requires the `oauth2:clients:manage` scope allowing generation of OAuth clients with the `app-engine:edge-connects:connect` scope, e.g. via the following policy statement: `ALLOW oauth2:clients:manage where oauth2:scopes='app-engine:edge-connects:connect'`
+   * The `oauth2:clients:manage` scope is not required if you provide an OAuth client ID.
+   *
+   * The OAuth client ID, secret and resource will be returned in the response. The OAuth client secret is not retrievable later on.
+   *
+   * @returns The EdgeConnect has been created successfully
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.createEdgeConnect({
+   *   body: {
+   *     hostPatterns: ["*.internal.org"],
+   *     modificationInfo: {
+   *       lastModifiedBy: "12345678-abcd-efgh-1234-123456789",
+   *       lastModifiedTime: "2022-01-01T01:02:03.165Z",
+   *     },
+   *   },
+   * });
+   */
   async createEdgeConnect(config) {
@@ -710,2 +754,16 @@ if (!config) {
   }
+  /**
+   * Get an EdgeConnect
+   *
+   * **Required scope:** app-engine:edge-connects:read
+   *
+   * @returns The EdgeConnect configuration
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.getEdgeConnect({
+   *   edgeConnectId: "11111111-2222-4444-3333-555555555555",
+   * });
+   */
   async getEdgeConnect(config) {
@@ -754,2 +812,21 @@ try {
   }
+  /**
+   * Update an EdgeConnect
+   *
+   * **Required scope:** app-engine:edge-connects:write
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.updateEdgeConnect({
+   *   edgeConnectId: "11111111-2222-4444-3333-555555555555",
+   *   body: {
+   *     hostPatterns: ["*.internal.org"],
+   *     modificationInfo: {
+   *       lastModifiedBy: "12345678-abcd-efgh-1234-123456789",
+   *       lastModifiedTime: "2022-01-01T01:02:03.165Z",
+   *     },
+   *   },
+   * });
+   */
   async updateEdgeConnect(config) {
@@ -815,2 +892,14 @@ if (!config) {
   }
+  /**
+   * Delete an EdgeConnect
+   *
+   * **Required scope:** app-engine:edge-connects:delete<br/><br/>Deletes the specified EdgeConnect configuration. If the configuration used an autogenerated OAuth client, then the `oauth2:clients:manage` for the `app-engine:edge-connects:connect` scope is required (e.g. via a policy statement like `ALLOW oauth2:clients:manage where oauth2:scopes='app-engine:edge-connects:connect'`) in order to allow the deletion of the corresponding OAuth client.
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.deleteEdgeConnect({
+   *   edgeConnectId: "11111111-2222-4444-3333-555555555555",
+   * });
+   */
   async deleteEdgeConnect(config) {
@@ -845,2 +934,17 @@ try {
   }
+  /**
+   * Rotate the secret of the autogenerated OAuth client of the given EdgeConnect.
+   *
+   * **Required scope:** oauth2:clients:manage<br/><br/>The secret rotation can only be used if the configured OAuth client is an autogenerated OAuth client. The scope `oauth2:clients:manage` for the `app-engine:edge-connects:connect` scope is required (e.g. via a policy like `ALLOW oauth2:clients:manage where oauth2:scopes='app-engine:edge-connects:connect'`).
+   *
+   * @returns The OAuth client secret was rotated successfully
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data =
+   *   await edgeConnectClient.rotateOAuthClientSecret({
+   *     edgeConnectId: "11111111-2222-4444-3333-555555555555",
+   *   });
+   */
   async rotateOAuthClientSecret(config) {
@@ -881,3 +985,6 @@ try {
         case 400: {
-          const responseValue = await response.body("text");
+          const responseValue = await response.body(
+            "text"
+            /* type from spec unsupported */
+          );
           throw new ClientRequestError(
@@ -906,2 +1013,16 @@ `400`,
   }
+  /**
+   * Gets the matching EdgeConnect including alternatives for a URL.
+   *
+   * **Required scope:** app-engine:edge-connects:read<br/><br/>Provides the EdgeConnect which matches the URL due to its configured host patterns. This EdgeConnect would receive a corresponding fetch request if done in the context of the Dynatrace runtime. In addition, this endpoint also provides other EdgeConnects which have matching host patterns that are not as specific (due to wildcard pattern usage) as the matched EdgeConnect
+   *
+   * @returns The matched EdgeConnect and considered alternatives which are more general
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.getMatchedEdgeConnects(
+   *   { url: "http://my.dynatrace.com" },
+   * );
+   */
   async getMatchedEdgeConnects(config) {
@@ -908,0 +1029,0 @@ if (!config) {

docs/DOCS.md

@@ -17,3 +17,3 @@ ---
   <div class="col" style={{textAlign: 'right'}}>
-    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-edge-connect/v/1.2.3" target="_blank" rel="noopener noreferrer">v1.2.3</a>
+    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-edge-connect/v/1.2.5" target="_blank" rel="noopener noreferrer">v1.2.5</a>
   </div>
@@ -33,2 +33,3 @@ </div>
 
+
 ### createEdgeConnect
@@ -48,3 +49,3 @@
 
-The OAuth client ID is optional.
+The name must not be longer than 50 characters and must be &apos;RFC 1123&apos; compliant. The OAuth client ID is optional.
 If no OAuth client ID is provided an OAuth client must be generated for that EdgeConnect. This additionally requires the `oauth2:clients:manage` scope allowing generation of OAuth clients with the `app-engine:edge-connects:connect` scope, e.g. via the following policy statement: `ALLOW oauth2:clients:manage where oauth2:scopes='app-engine:edge-connects:connect'`
@@ -77,3 +78,2 @@ The `oauth2:clients:manage` scope is not required if you provide an OAuth client ID.
 Code example
-
 </summary>
@@ -102,2 +102,3 @@
 
+
 ### deleteEdgeConnect
@@ -134,3 +135,2 @@
 Code example
-
 </summary>
@@ -153,2 +153,3 @@
 
+
 ### getEdgeConnect
@@ -187,3 +188,2 @@
 Code example
-
 </summary>
@@ -206,2 +206,3 @@
 
+
 ### getMatchedEdgeConnects
@@ -242,3 +243,2 @@
 Code example
-
 </summary>
@@ -261,2 +261,3 @@
 
+
 ### listEdgeConnects
@@ -298,3 +299,2 @@
 Code example
-
 </summary>
@@ -315,2 +315,3 @@
 
+
 ### rotateOAuthClientSecret
@@ -351,3 +352,2 @@
 Code example
-
 </summary>
@@ -371,2 +371,3 @@
 
+
 ### updateEdgeConnect
@@ -402,3 +403,2 @@
 Code example
-
 </summary>
@@ -405,0 +405,0 @@

dynatrace-metadata.json

@@ -12,5 +12,5 @@ {
     "title": "AppEngine - EdgeConnect",
-    "version": "1.1.0",
+    "version": "1.1.1",
     "baseUrl": "/platform/app-engine/edge-connect/v1"
   }
 }

esm/index.js

@@ -546,2 +546,7 @@ /**
   httpClient;
+  /**
+   * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a EdgeConnectClient. Custom http client should implement {HttpClient} interface.
+   * @example
+   * const edgeConnectClientNodeJs = new EdgeConnectClient(yourCustomImplementation);
+   */
   constructor(httpClientImplementation) {
@@ -551,2 +556,14 @@ this.httpClient = httpClientImplementation;
   }
+  /**
+   * List all EdgeConnects
+   *
+   * **Required scope:** app-engine:edge-connects:read
+   *
+   * @returns A list of all EdgeConnects
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.listEdgeConnects();
+   */
   async listEdgeConnects(config = {}) {
@@ -604,2 +621,29 @@ if (!config) {
   }
+  /**
+   * Create a new EdgeConnect.
+   *
+   * **Required scope:** app-engine:edge-connects:write<br/><br/>You can either specify a UUID in the request body or a random UUID
+   * will be assigned to the created EdgeConnect configuration.
+   *
+   * The name must not be longer than 50 characters and must be 'RFC 1123' compliant. The OAuth client ID is optional.
+   * If no OAuth client ID is provided an OAuth client must be generated for that EdgeConnect. This additionally requires the `oauth2:clients:manage` scope allowing generation of OAuth clients with the `app-engine:edge-connects:connect` scope, e.g. via the following policy statement: `ALLOW oauth2:clients:manage where oauth2:scopes='app-engine:edge-connects:connect'`
+   * The `oauth2:clients:manage` scope is not required if you provide an OAuth client ID.
+   *
+   * The OAuth client ID, secret and resource will be returned in the response. The OAuth client secret is not retrievable later on.
+   *
+   * @returns The EdgeConnect has been created successfully
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.createEdgeConnect({
+   *   body: {
+   *     hostPatterns: ["*.internal.org"],
+   *     modificationInfo: {
+   *       lastModifiedBy: "12345678-abcd-efgh-1234-123456789",
+   *       lastModifiedTime: "2022-01-01T01:02:03.165Z",
+   *     },
+   *   },
+   * });
+   */
   async createEdgeConnect(config) {
@@ -677,2 +721,16 @@ if (!config) {
   }
+  /**
+   * Get an EdgeConnect
+   *
+   * **Required scope:** app-engine:edge-connects:read
+   *
+   * @returns The EdgeConnect configuration
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.getEdgeConnect({
+   *   edgeConnectId: "11111111-2222-4444-3333-555555555555",
+   * });
+   */
   async getEdgeConnect(config) {
@@ -721,2 +779,21 @@ try {
   }
+  /**
+   * Update an EdgeConnect
+   *
+   * **Required scope:** app-engine:edge-connects:write
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.updateEdgeConnect({
+   *   edgeConnectId: "11111111-2222-4444-3333-555555555555",
+   *   body: {
+   *     hostPatterns: ["*.internal.org"],
+   *     modificationInfo: {
+   *       lastModifiedBy: "12345678-abcd-efgh-1234-123456789",
+   *       lastModifiedTime: "2022-01-01T01:02:03.165Z",
+   *     },
+   *   },
+   * });
+   */
   async updateEdgeConnect(config) {
@@ -782,2 +859,14 @@ if (!config) {
   }
+  /**
+   * Delete an EdgeConnect
+   *
+   * **Required scope:** app-engine:edge-connects:delete<br/><br/>Deletes the specified EdgeConnect configuration. If the configuration used an autogenerated OAuth client, then the `oauth2:clients:manage` for the `app-engine:edge-connects:connect` scope is required (e.g. via a policy statement like `ALLOW oauth2:clients:manage where oauth2:scopes='app-engine:edge-connects:connect'`) in order to allow the deletion of the corresponding OAuth client.
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.deleteEdgeConnect({
+   *   edgeConnectId: "11111111-2222-4444-3333-555555555555",
+   * });
+   */
   async deleteEdgeConnect(config) {
@@ -812,2 +901,17 @@ try {
   }
+  /**
+   * Rotate the secret of the autogenerated OAuth client of the given EdgeConnect.
+   *
+   * **Required scope:** oauth2:clients:manage<br/><br/>The secret rotation can only be used if the configured OAuth client is an autogenerated OAuth client. The scope `oauth2:clients:manage` for the `app-engine:edge-connects:connect` scope is required (e.g. via a policy like `ALLOW oauth2:clients:manage where oauth2:scopes='app-engine:edge-connects:connect'`).
+   *
+   * @returns The OAuth client secret was rotated successfully
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data =
+   *   await edgeConnectClient.rotateOAuthClientSecret({
+   *     edgeConnectId: "11111111-2222-4444-3333-555555555555",
+   *   });
+   */
   async rotateOAuthClientSecret(config) {
@@ -848,3 +952,6 @@ try {
         case 400: {
-          const responseValue = await response.body("text");
+          const responseValue = await response.body(
+            "text"
+            /* type from spec unsupported */
+          );
           throw new ClientRequestError(
@@ -873,2 +980,16 @@ `400`,
   }
+  /**
+   * Gets the matching EdgeConnect including alternatives for a URL.
+   *
+   * **Required scope:** app-engine:edge-connects:read<br/><br/>Provides the EdgeConnect which matches the URL due to its configured host patterns. This EdgeConnect would receive a corresponding fetch request if done in the context of the Dynatrace runtime. In addition, this endpoint also provides other EdgeConnects which have matching host patterns that are not as specific (due to wildcard pattern usage) as the matched EdgeConnect
+   *
+   * @returns The matched EdgeConnect and considered alternatives which are more general
+   *
+   * @example <caption>Code example</caption>
+   * import { edgeConnectClient } from "@dynatrace-sdk/client-app-engine-edge-connect";
+   *
+   * const data = await edgeConnectClient.getMatchedEdgeConnects(
+   *   { url: "http://my.dynatrace.com" },
+   * );
+   */
   async getMatchedEdgeConnects(config) {
@@ -875,0 +996,0 @@ if (!config) {

package.json

 {
   "name": "@dynatrace-sdk/client-app-engine-edge-connect",
-  "version": "1.2.3",
+  "version": "1.2.5",
   "dependencies": {
@@ -5,0 +5,0 @@ "@dynatrace-sdk/error-handlers": "^1.2.0",

README.md

 # @dynatrace-sdk/client-app-engine-edge-connect
 
-[![npm](https://img.shields.io/badge/npm-v1.2.3-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-edge-connect/v/1.2.3)
+[![npm](https://img.shields.io/badge/npm-v1.2.5-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-edge-connect/v/1.2.5)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -38,6 +38,7 @@
 
+<a name="createedgeconnect"></a>
 ### createEdgeConnect
 
 <div class="padding-bottom--md">
-<strong>edgeConnectClient.createEdgeConnect(config): Promise&lt;[EdgeConnect](#edgeconnect)&gt;</strong>
+<strong>edgeConnectClient.createEdgeConnect(config): Promise&lt;<a href="#edgeconnect">EdgeConnect</a>&gt;</strong>
 
@@ -53,3 +54,3 @@ <div class="padding-left--md">
 
-The OAuth client ID is optional.
+The name must not be longer than 50 characters and must be &apos;RFC 1123&apos; compliant. The OAuth client ID is optional.
 If no OAuth client ID is provided an OAuth client must be generated for that EdgeConnect. This additionally requires the `oauth2:clients:manage` scope allowing generation of OAuth clients with the `app-engine:edge-connects:connect` scope, e.g. via the following policy statement: `ALLOW oauth2:clients:manage where oauth2:scopes='app-engine:edge-connects:connect'`
@@ -69,3 +70,3 @@ The `oauth2:clients:manage` scope is not required if you provide an OAuth client ID.
 | --- | --- |
-|config.body<sup>*required</sup>|[EdgeConnect](#edgeconnect)| 
+|config.body<sup>*required</sup>|<a href="#edgeconnect" target="_blank" rel="noopener noreferrer">EdgeConnect</a>| 
 
@@ -83,3 +84,2 @@
 Code example
-
 </summary>
@@ -108,2 +108,3 @@
 
+<a name="deleteedgeconnect"></a>
 ### deleteEdgeConnect
@@ -140,3 +141,2 @@
 Code example
-
 </summary>
@@ -159,6 +159,7 @@
 
+<a name="getedgeconnect"></a>
 ### getEdgeConnect
 
 <div class="padding-bottom--md">
-<strong>edgeConnectClient.getEdgeConnect(config): Promise&lt;[EdgeConnect](#edgeconnect)&gt;</strong>
+<strong>edgeConnectClient.getEdgeConnect(config): Promise&lt;<a href="#edgeconnect">EdgeConnect</a>&gt;</strong>
 
@@ -193,3 +194,2 @@ <div class="padding-left--md">
 Code example
-
 </summary>
@@ -212,6 +212,7 @@
 
+<a name="getmatchededgeconnects"></a>
 ### getMatchedEdgeConnects
 
 <div class="padding-bottom--md">
-<strong>edgeConnectClient.getMatchedEdgeConnects(config): Promise&lt;[MatchedResponse](#matchedresponse)&gt;</strong>
+<strong>edgeConnectClient.getMatchedEdgeConnects(config): Promise&lt;<a href="#matchedresponse" target="_blank" rel="noopener noreferrer">MatchedResponse</a>&gt;</strong>
 
@@ -248,3 +249,2 @@ <div class="padding-left--md">
 Code example
-
 </summary>
@@ -267,6 +267,7 @@
 
+<a name="listedgeconnects"></a>
 ### listEdgeConnects
 
 <div class="padding-bottom--md">
-<strong>edgeConnectClient.listEdgeConnects(config): Promise&lt;[EdgeConnects](#edgeconnects)&gt;</strong>
+<strong>edgeConnectClient.listEdgeConnects(config): Promise&lt;<a href="#edgeconnects">EdgeConnects</a>&gt;</strong>
 
@@ -304,3 +305,2 @@ <div class="padding-left--md">
 Code example
-
 </summary>
@@ -321,6 +321,7 @@
 
+<a name="rotateoauthclientsecret"></a>
 ### rotateOAuthClientSecret
 
 <div class="padding-bottom--md">
-<strong>edgeConnectClient.rotateOAuthClientSecret(config): Promise&lt;[OAuthClientRotationResponse](#oauthclientrotationresponse)&gt;</strong>
+<strong>edgeConnectClient.rotateOAuthClientSecret(config): Promise&lt;<a href="#oauthclientrotationresponse" target="_blank" rel="noopener noreferrer">OAuthClientRotationResponse</a>&gt;</strong>
 
@@ -357,3 +358,2 @@ <div class="padding-left--md">
 Code example
-
 </summary>
@@ -377,2 +377,3 @@
 
+<a name="updateedgeconnect"></a>
 ### updateEdgeConnect
@@ -398,3 +399,3 @@
 | --- | --- | --- |
-|config.body<sup>*required</sup>|[EdgeConnect](#edgeconnect)| |
+|config.body<sup>*required</sup>|<a href="#edgeconnect">EdgeConnect</a>| |
 |config.edgeConnectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Specify the ID of the EdgeConnect |
@@ -409,3 +410,2 @@
 Code example
-
 </summary>
@@ -461,4 +461,4 @@
 |managedByDynatraceOperator|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|Flag to identify if an EdgeConnect is managed by the Dynatrace operator. False by default! |
-|metadata|[Metadata](#metadata)| |
-|modificationInfo|[ModificationInfo](#modificationinfo)| |
+|metadata|<a href="#metadata" target="_blank" rel="noopener noreferrer">Metadata</a>| |
+|modificationInfo|<a href="#modificationinfo">ModificationInfo</a>| |
 |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| |
@@ -490,3 +490,3 @@ |oauthClientId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of OAuth client used to connect by the EdgeConnect |
 | --- | --- | --- |
-|edgeConnects|Array&lt;[EdgeConnect](#edgeconnect)&gt;| |
+|edgeConnects|Array&lt;<a href="#edgeconnect" target="_blank" rel="noopener noreferrer">EdgeConnect</a>&gt;| |
 |totalCount|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Total number of currently configured EdgeConnects |
@@ -504,3 +504,3 @@
 |code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)| 
-|details|[ErrorDetails](#errordetails)| 
+|details|<a href="#errordetails">ErrorDetails</a>| 
 |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
@@ -517,3 +517,3 @@
 | --- | --- |
-|constraintViolations|Array&lt;[ConstraintViolation](#constraintviolation)&gt;| 
+|constraintViolations|Array&lt;<a href="#constraintviolation" target="_blank" rel="noopener noreferrer">ConstraintViolation</a>&gt;| 
 |missingScopes|Array&lt;[string](https://developer.mozilla.org/en-US/docs/Glossary/String)&gt;|
@@ -530,3 +530,3 @@
 | --- | --- |
-|error<sup>*required</sup>|[Error](#error)|
+|error<sup>*required</sup>|<a href="#error">Error</a>|
 
@@ -544,3 +544,3 @@ ### MatchedEdgeConnect
 |matchedPattern<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)| 
-|metadata|[Metadata](#metadata)| 
+|metadata|<a href="#metadata" target="_blank" rel="noopener noreferrer">Metadata</a>| 
 |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
@@ -557,4 +557,4 @@
 | --- | --- |
-|matched|[MatchedEdgeConnect](#matchededgeconnect)| 
-|secondaryMatching|Array&lt;[MatchedEdgeConnect](#matchededgeconnect)&gt;|
+|matched|<a href="#matchededgeconnect">MatchedEdgeConnect</a>| 
+|secondaryMatching|Array&lt;<a href="#matchededgeconnect" target="_blank" rel="noopener noreferrer">MatchedEdgeConnect</a>&gt;|
 
@@ -570,3 +570,3 @@ ### Metadata
 | --- | --- |
-|instances|Array&lt;[EdgeConnectInstance](#edgeconnectinstance)&gt;| 
+|instances|Array&lt;<a href="#edgeconnectinstance">EdgeConnectInstance</a>&gt;| 
 |oauthClientStatus|MetadataOauthClientStatus|
@@ -600,2 +600,3 @@
 
+<a name="metadataoauthclientstatus"></a>
 ### MetadataOauthClientStatus
@@ -602,0 +603,0 @@

types/packages/client/app-engine-edge-connect/src/lib/apis/edge-connect-api.d.ts

@@ -71,3 +71,3 @@ import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
      *
-     * The OAuth client ID is optional.
+     * The name must not be longer than 50 characters and must be 'RFC 1123' compliant. The OAuth client ID is optional.
      * If no OAuth client ID is provided an OAuth client must be generated for that EdgeConnect. This additionally requires the `oauth2:clients:manage` scope allowing generation of OAuth clients with the `app-engine:edge-connects:connect` scope, e.g. via the following policy statement: `ALLOW oauth2:clients:manage where oauth2:scopes='app-engine:edge-connects:connect'`
@@ -74,0 +74,0 @@ * The `oauth2:clients:manage` scope is not required if you provide an OAuth client ID.

types/packages/client/app-engine-edge-connect/src/lib/models/edge-connect-name.d.ts

@@ -6,2 +6,2 @@ /**
  */
-export declare type EdgeConnectName = string;
+export type EdgeConnectName = string;

types/packages/client/app-engine-edge-connect/src/lib/models/edge-connect-name.transformation.d.ts

 import { EdgeConnectName } from './edge-connect-name';
-export declare type AsJson = string;
+export type AsJson = string;
 export declare function fromJson($model: AsJson): EdgeConnectName;
 export declare function toJson($model: EdgeConnectName): AsJson;

types/packages/client/app-engine-edge-connect/src/lib/models/host-pattern.d.ts

@@ -6,2 +6,2 @@ /**
  */
-export declare type HostPattern = string;
+export type HostPattern = string;

types/packages/client/app-engine-edge-connect/src/lib/models/host-pattern.transformation.d.ts

 import { HostPattern } from './host-pattern';
-export declare type AsJson = string;
+export type AsJson = string;
 export declare function fromJson($model: AsJson): HostPattern;
 export declare function toJson($model: HostPattern): AsJson;

types/packages/client/app-engine-edge-connect/src/lib/models/metadata-oauth-client-status.transformation.d.ts

 import { MetadataOauthClientStatus } from './metadata-oauth-client-status';
-export declare type AsJson = string;
+export type AsJson = string;
 export declare function fromJson($model: AsJson): MetadataOauthClientStatus;
 export declare function toJson($model: MetadataOauthClientStatus): AsJson;

types/packages/client/app-engine-edge-connect/src/lib/utils/url-helpers.d.ts

@@ -1,2 +0,2 @@
-declare type QueryParamsType = Record<string | number, any>;
+type QueryParamsType = Record<string | number, any>;
 interface ParametersFlags {
@@ -3,0 +3,0 @@ explode?: Record<string, boolean>;

types/packages/http-client/src/lib/platform/abort-controller.d.ts

@@ -5,3 +5,3 @@ import * as types from '../types';
 };
-declare type AbortController = InstanceType<typeof AbortController>;
+type AbortController = InstanceType<typeof AbortController>;
 export { AbortController };

types/packages/http-client/src/lib/platform/abort-signal.d.ts

@@ -5,3 +5,3 @@ import * as types from '../types';
 };
-declare type AbortSignal = InstanceType<typeof AbortSignal>;
+type AbortSignal = InstanceType<typeof AbortSignal>;
 export { AbortSignal };

types/packages/http-client/src/lib/types/data-types.d.ts

@@ -7,3 +7,3 @@ /// <reference types="node" />
  */
-export declare type DataTypes = {
+export type DataTypes = {
     /**
@@ -10,0 +10,0 @@ * A text type.

types/packages/http-client/src/lib/types/form-data-request-body.d.ts

@@ -79,6 +79,6 @@ /// <reference types="node" />
  */
-export declare type FormDataRequestField = TextFormDataRequestField | JsonFormDataRequestField | BinaryFormDataRequestField;
+export type FormDataRequestField = TextFormDataRequestField | JsonFormDataRequestField | BinaryFormDataRequestField;
 /**
  * Represents a multipart/form-data body.
  */
-export declare type FormDataRequestBody = Array<FormDataRequestField>;
+export type FormDataRequestBody = Array<FormDataRequestField>;

types/packages/http-client/src/lib/types/form-data-response-body.d.ts

@@ -14,3 +14,3 @@ import { Binary } from './binary';
 }
-export declare type FormDataResponseField = TextFormDataResponseField | BinaryFormDataResponseField;
-export declare type FormDataResponseBody = Array<FormDataResponseField>;
+export type FormDataResponseField = TextFormDataResponseField | BinaryFormDataResponseField;
+export type FormDataResponseBody = Array<FormDataResponseField>;

types/packages/http-client/src/lib/types/request-body-types.d.ts

@@ -9,3 +9,3 @@ /// <reference types="node" />
  */
-export declare type RequestBodyTypes = {
+export type RequestBodyTypes = {
     /**
@@ -12,0 +12,0 @@ * A text request body type.

types/packages/http-client/src/lib/types/response-body-types.d.ts

@@ -9,3 +9,3 @@ /// <reference types="node" />
  */
-export declare type ResponseBodyTypes = {
+export type ResponseBodyTypes = {
     /**
@@ -12,0 +12,0 @@ * A text response body type.

types/packages/platform/error-handlers/src/lib/types/global-dt-runtime-with-error-handlers.d.ts

 import { DtRuntimeErrorHandlers } from './dt-runtime-error-handlers';
 /** @ignore */
-export declare type GlobalDtRuntimeWithErrorHandlers = typeof globalThis & {
+export type GlobalDtRuntimeWithErrorHandlers = typeof globalThis & {
     dtRuntime?: {
@@ -5,0 +5,0 @@ errorHandlers?: DtRuntimeErrorHandlers;

types/packages/platform/error-handlers/src/lib/types/global-error-serializer.d.ts

@@ -10,2 +10,2 @@ import { SerializedError } from './serialized-error';
  */
-export declare type GlobalErrorSerializer = (error: any) => Promise<SerializedError | undefined>;
+export type GlobalErrorSerializer = (error: any) => Promise<SerializedError | undefined>;

types/packages/platform/error-handlers/src/lib/types/serialized-error.d.ts

@@ -8,4 +8,4 @@ import { CommonSerializedError } from './common-serialized-error';
  */
-export declare type SerializedError = (HttpSerializedError | CommonSerializedError) & {
+export type SerializedError = (HttpSerializedError | CommonSerializedError) & {
     traceId?: string;
 };

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

173411

increased by8.85%

Number of package files

105

increased by0.96%

Lines of code

3453

increased by9.45%

Number of lines in readme file

592

increased by0.17%

No dependency changes