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

Comparing version 1.7.1 to 1.7.2

CHANGELOG.md

@@ -5,2 +5,10 @@ # AppEngine - Registry
 
+## 1.7.2
+
+### Patch Changes
+
+- Do not print empty fields in the default message of an error. APPDEV-7630
+- Update documentation. APPDEV-8154
+- Updated dependencies 
+
 ## 1.7.1
@@ -7,0 +15,0 @@

cjs/index.js

@@ -178,2 +178,4 @@ /**
   Object.entries(details).forEach(([name, data]) => {
+    if (!data)
+      return;
     const serializedData = serializeData(data);
@@ -1008,3 +1010,3 @@ switch (name) {
             const errorBody = fromJson26(responseValue);
-            throw new ErrorEnvelopeError("400", response, errorBody, getErrorMessage(errorBody, "Bad Request"), e);
+            throw new ErrorEnvelopeError(`400`, response, errorBody, getErrorMessage(errorBody, "Bad Request"), e);
           } catch (err) {
@@ -1011,0 +1013,0 @@ if (err instanceof ErrorEnvelopeError) {

docs/DOCS.md

@@ -29,3 +29,3 @@ ---
   <div class="col" style={{textAlign: 'right'}}>
-    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry/v/1.7.1" target="_blank" rel="noopener noreferrer">v1.7.1</a>
+    <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry/v/1.7.2" target="_blank" rel="noopener noreferrer">v1.7.2</a>
   </div>
@@ -65,4 +65,4 @@ </div>
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |config.addFields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Comma-separated list of field names that are added to the default set of fields.</p> <p>You can include the following additional fields:</p> <ul> <li><code>resourceContext</code></li> <li><code>resourceStatus.subResourceStatuses</code></li> <li><code>manifest</code></li> <li><code>isBuiltin</code></li> <li><code>isolatedUri</code></li> </ul>  |
@@ -118,4 +118,4 @@ |config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier for the app |
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |config.addFields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Comma-separated list of field names that are added to the default set of fields.</p> <p>You can include the following additional fields:</p> <ul> <li><code>resourceContext</code></li> <li><code>resourceStatus.subResourceStatuses</code></li> <li><code>manifest</code></li> <li><code>isBuiltin</code></li> <li><code>isolatedUri</code></li> </ul>  |
@@ -175,4 +175,4 @@ |config.includeAllAppVersions|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>If <code>true</code>, all versions of every app are included in the response.</p> <p>If <code>false</code>, only the current version of every app is included.</p> <p>This is relevant while an app is being updated. During this time typically two versions of the same app exist, the current one and the new one.</p>  <i>default:</i> <code>false</code>|
 
-| Name | Type|
-|---|---|
+| Name | Type |
+| --- | --- |
 |config.body<sup>*required</sup>|Blob| 
@@ -227,4 +227,4 @@
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |config.query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A whitespace separated list of search terms. For an action to match, each search term must be contained in either: app name, app description, action name or action description.</p> <p>Search terms are case insensitive and each additional search term restricts actions further. Maximum length is 256 characters.</p>  |
@@ -278,4 +278,4 @@
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier for the app |
@@ -399,9 +399,11 @@
 
+
 Default Content Security Policies for apps.
 
-| Name | Type|
-|---|---|
+| Name | Type |
+| --- | --- |
 |policyDirectives<sup>*required</sup>|[AppDefaultCspPolicyDirectives](#appdefaultcsppolicydirectives)|
 
 ### AppDefaultCspPolicyDirectives
+**type**: Record&lt;string, string[] | undefined&gt;
 
@@ -416,6 +418,7 @@
 
+
 Representation of an app icon.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |href<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The reference to an app icon |
@@ -427,6 +430,7 @@
 
+
 A minimal representation of an app.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |appIcon|[AppIcon](#appicon)| |
@@ -449,6 +453,7 @@ |description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the app |
 
+
 A list of minimal app representations.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |apps<sup>*required</sup>|Array&lt;[AppInfo](#appinfo)&gt;|The list of minimal app representations. |
@@ -460,6 +465,7 @@
 
+
 Representation of an app&apos;s isolated uri.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |baseUrl<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The base URL of an app |
@@ -473,6 +479,7 @@ |url<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL of an app |
 
+
 Representation of an app&apos;s signature verification.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |publisher|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The organization name of the app publisher. |
@@ -485,6 +492,7 @@ |signed<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|App is signed and its signature has been verified. |
 
+
 A minimal representation of an installed/updated app.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of the installed/updated app |
@@ -497,6 +505,7 @@ |warnings|Array&lt;[Warning](#warning)&gt;|Contains warning information although the request was successful |
 
+
 Contains information about a constraint violation caused by invalid input.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message |
@@ -509,6 +518,7 @@ |path<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The path of the property that caused the constraint violation |
 
+
 Contains information for 4xx and 5xx errors.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code |
@@ -524,6 +534,7 @@ |details|[ErrorDetails](#errordetails)| |
 
+
 Contains details for 4xx and 5xx errors.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |constraintViolations|Array&lt;[ConstraintViolation](#constraintviolation)&gt;|A list of constraint violations |
@@ -539,6 +550,7 @@ |errorCode|MaxNumberOfInstalledCustomAppsExceeded| |
 
+
 Additional properties related to the provided error code
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |customAppLimit|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Limit for max amount of installed custom apps in a tenant |
@@ -550,6 +562,7 @@
 
+
 Error response for all 4xx and 5xx errors.
 
-| Name | Type|
-|---|---|
+| Name | Type |
+| --- | --- |
 |error<sup>*required</sup>|[Error](#error)|
@@ -561,6 +574,7 @@
 
+
 Modification information about the app
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |createdAt<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Timestamp when the resource was created in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
@@ -575,6 +589,7 @@ |createdBy<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|UserId of the user that created the resource |
 
+
 Additional resource context information
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |operations|Array&lt;ResourceContextOperationsItem&gt;|<p>Operations that are allowed on the app depending on the user's permissions.</p> <ul> <li> <p><code>run</code>: user is allowed to run the app.</p> </li> <li> <p><code>update</code>: user is allowed to update the app.</p> </li> <li> <p><code>uninstall</code>: user is allowed to uninstall the app.</p> </li> </ul>  |
@@ -586,6 +601,7 @@
 
+
 The status of the app plus additional details.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |operationStateBeforeError|ResourceStatusOperationStateBeforeError| |
@@ -600,6 +616,7 @@ |pendingOperation|ResourceStatusPendingOperation| |
 
+
 List of apps with actions. Apps are sorted by name in ascending order.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |actions<sup>*required</sup>|Array&lt;SearchAppActionActionsItem&gt;|List of app actions. Actions are sorted by name in ascending order. Actions without name are last. |
@@ -615,4 +632,5 @@ |id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|App id |
 
-| Name | Type| Description|
-|---|---|---|
+
+| Name | Type | Description |
+| --- | --- | --- |
 |apps<sup>*required</sup>|Array&lt;[SearchAppAction](#searchappaction)&gt;| |
@@ -625,6 +643,7 @@ |totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Total actions count. |
 
+
 Contains information about a constraint violation caused by invalid input.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message |
@@ -637,6 +656,7 @@ |path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The path of the property that caused the constraint violation |
 
+
 Additional error information that can be present if the sub resource `status` is `FAILED`
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |constraintViolations|Array&lt;[SubResourceConstraintViolation](#subresourceconstraintviolation)&gt;|A list of constraint violations |
@@ -651,6 +671,7 @@ |errorCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An error code that can be used determine the nature of an error and why it occurred. |
 
+
 The status of the sub resource.
 
-| Name | Type|
-|---|---|
+| Name | Type |
+| --- | --- |
 |error|[SubResourceError](#subresourceerror)| 
@@ -664,6 +685,7 @@ |status<sup>*required</sup>|SubResourceStatusStatus|
 
+
 A warning.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The warning message. |
@@ -670,0 +692,0 @@

dynatrace-metadata.json

@@ -7,3 +7,3 @@ {
       "name": "@dynatrace-sdk/template-typescript-client",
-      "version": "0.18.12"
+      "version": "0.19.1"
     }
@@ -10,0 +10,0 @@ },

esm/index.js

@@ -121,2 +121,4 @@ /**
   Object.entries(details).forEach(([name, data]) => {
+    if (!data)
+      return;
     const serializedData = serializeData(data);
@@ -951,3 +953,3 @@ switch (name) {
             const errorBody = fromJson26(responseValue);
-            throw new ErrorEnvelopeError("400", response, errorBody, getErrorMessage(errorBody, "Bad Request"), e);
+            throw new ErrorEnvelopeError(`400`, response, errorBody, getErrorMessage(errorBody, "Bad Request"), e);
           } catch (err) {
@@ -954,0 +956,0 @@ if (err instanceof ErrorEnvelopeError) {

package.json

 {
   "name": "@dynatrace-sdk/client-app-engine-registry",
-  "version": "1.7.1",
+  "version": "1.7.2",
   "description": "Manage Dynatrace AppEngine apps.",
@@ -8,3 +8,3 @@ "license": "Apache-2.0",
     "@dynatrace-sdk/error-handlers": "^1.2.0",
-    "@dynatrace-sdk/http-client": "^1.0.10"
+    "@dynatrace-sdk/http-client": "^1.2.0"
   },
@@ -11,0 +11,0 @@ "main": "./cjs/index.js",

README.md

 # @dynatrace-sdk/client-app-engine-registry
 
-[![npm](https://img.shields.io/badge/npm-v1.7.1-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry/v/1.7.1)
+[![npm](https://img.shields.io/badge/npm-v1.7.2-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry/v/1.7.2)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -70,4 +70,4 @@
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |config.addFields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Comma-separated list of field names that are added to the default set of fields.</p> <p>You can include the following additional fields:</p> <ul> <li><code>resourceContext</code></li> <li><code>resourceStatus.subResourceStatuses</code></li> <li><code>manifest</code></li> <li><code>isBuiltin</code></li> <li><code>isolatedUri</code></li> </ul>  |
@@ -123,4 +123,4 @@ |config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier for the app |
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |config.addFields|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>Comma-separated list of field names that are added to the default set of fields.</p> <p>You can include the following additional fields:</p> <ul> <li><code>resourceContext</code></li> <li><code>resourceStatus.subResourceStatuses</code></li> <li><code>manifest</code></li> <li><code>isBuiltin</code></li> <li><code>isolatedUri</code></li> </ul>  |
@@ -180,4 +180,4 @@ |config.includeAllAppVersions|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>If <code>true</code>, all versions of every app are included in the response.</p> <p>If <code>false</code>, only the current version of every app is included.</p> <p>This is relevant while an app is being updated. During this time typically two versions of the same app exist, the current one and the new one.</p>  <i>default:</i> <code>false</code>|
 
-| Name | Type|
-|---|---|
+| Name | Type |
+| --- | --- |
 |config.body<sup>*required</sup>|Blob| 
@@ -232,4 +232,4 @@
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |config.query|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>A whitespace separated list of search terms. For an action to match, each search term must be contained in either: app name, app description, action name or action description.</p> <p>Search terms are case insensitive and each additional search term restricts actions further. Maximum length is 256 characters.</p>  |
@@ -283,4 +283,4 @@
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier for the app |
@@ -404,9 +404,11 @@
 
+
 Default Content Security Policies for apps.
 
-| Name | Type|
-|---|---|
+| Name | Type |
+| --- | --- |
 |policyDirectives<sup>*required</sup>|[AppDefaultCspPolicyDirectives](#appdefaultcsppolicydirectives)|
 
 ### AppDefaultCspPolicyDirectives
+**type**: Record&lt;string, string[] | undefined&gt;
 
@@ -421,6 +423,7 @@
 
+
 Representation of an app icon.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |href<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The reference to an app icon |
@@ -432,6 +435,7 @@
 
+
 A minimal representation of an app.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |appIcon|[AppIcon](#appicon)| |
@@ -454,6 +458,7 @@ |description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the app |
 
+
 A list of minimal app representations.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |apps<sup>*required</sup>|Array&lt;[AppInfo](#appinfo)&gt;|The list of minimal app representations. |
@@ -465,6 +470,7 @@
 
+
 Representation of an app&apos;s isolated uri.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |baseUrl<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The base URL of an app |
@@ -478,6 +484,7 @@ |url<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL of an app |
 
+
 Representation of an app&apos;s signature verification.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |publisher|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The organization name of the app publisher. |
@@ -490,6 +497,7 @@ |signed<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|App is signed and its signature has been verified. |
 
+
 A minimal representation of an installed/updated app.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of the installed/updated app |
@@ -502,6 +510,7 @@ |warnings|Array&lt;[Warning](#warning)&gt;|Contains warning information although the request was successful |
 
+
 Contains information about a constraint violation caused by invalid input.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message |
@@ -514,6 +523,7 @@ |path<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The path of the property that caused the constraint violation |
 
+
 Contains information for 4xx and 5xx errors.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code |
@@ -529,6 +539,7 @@ |details|[ErrorDetails](#errordetails)| |
 
+
 Contains details for 4xx and 5xx errors.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |constraintViolations|Array&lt;[ConstraintViolation](#constraintviolation)&gt;|A list of constraint violations |
@@ -544,6 +555,7 @@ |errorCode|MaxNumberOfInstalledCustomAppsExceeded| |
 
+
 Additional properties related to the provided error code
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |customAppLimit|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Limit for max amount of installed custom apps in a tenant |
@@ -555,6 +567,7 @@
 
+
 Error response for all 4xx and 5xx errors.
 
-| Name | Type|
-|---|---|
+| Name | Type |
+| --- | --- |
 |error<sup>*required</sup>|[Error](#error)|
@@ -566,6 +579,7 @@
 
+
 Modification information about the app
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |createdAt<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Timestamp when the resource was created in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') |
@@ -580,6 +594,7 @@ |createdBy<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|UserId of the user that created the resource |
 
+
 Additional resource context information
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |operations|Array&lt;ResourceContextOperationsItem&gt;|<p>Operations that are allowed on the app depending on the user's permissions.</p> <ul> <li> <p><code>run</code>: user is allowed to run the app.</p> </li> <li> <p><code>update</code>: user is allowed to update the app.</p> </li> <li> <p><code>uninstall</code>: user is allowed to uninstall the app.</p> </li> </ul>  |
@@ -591,6 +606,7 @@
 
+
 The status of the app plus additional details.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |operationStateBeforeError|ResourceStatusOperationStateBeforeError| |
@@ -605,6 +621,7 @@ |pendingOperation|ResourceStatusPendingOperation| |
 
+
 List of apps with actions. Apps are sorted by name in ascending order.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |actions<sup>*required</sup>|Array&lt;SearchAppActionActionsItem&gt;|List of app actions. Actions are sorted by name in ascending order. Actions without name are last. |
@@ -620,4 +637,5 @@ |id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|App id |
 
-| Name | Type| Description|
-|---|---|---|
+
+| Name | Type | Description |
+| --- | --- | --- |
 |apps<sup>*required</sup>|Array&lt;[SearchAppAction](#searchappaction)&gt;| |
@@ -630,6 +648,7 @@ |totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Total actions count. |
 
+
 Contains information about a constraint violation caused by invalid input.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message |
@@ -642,6 +661,7 @@ |path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The path of the property that caused the constraint violation |
 
+
 Additional error information that can be present if the sub resource `status` is `FAILED`
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |constraintViolations|Array&lt;[SubResourceConstraintViolation](#subresourceconstraintviolation)&gt;|A list of constraint violations |
@@ -656,6 +676,7 @@ |errorCode|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|An error code that can be used determine the nature of an error and why it occurred. |
 
+
 The status of the sub resource.
 
-| Name | Type|
-|---|---|
+| Name | Type |
+| --- | --- |
 |error|[SubResourceError](#subresourceerror)| 
@@ -669,6 +690,7 @@ |status<sup>*required</sup>|SubResourceStatusStatus|
 
+
 A warning.
 
-| Name | Type| Description|
-|---|---|---|
+| Name | Type | Description |
+| --- | --- | --- |
 |message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The warning message. |
@@ -675,0 +697,0 @@

types/packages/http-client/src/index.d.ts

 export { AbortController, AbortSignal, BaseError, Binary, BinaryFormDataRequestField, BinaryFormDataResponseField, DataTypeError, DataTypes, FormDataRequestBody, FormDataRequestField, FormDataResponseBody, FormDataResponseField, Headers, HttpClient, HttpClientAbortError, HttpClientNetworkError, HttpClientRequestError, HttpClientRequestOptions, HttpClientResponse, HttpClientResponseError, JsonFormDataRequestField, RequestBodyTypes, ResponseBodyTypes, StatusValidator, TextFormDataRequestField, TextFormDataResponseField, UnsupportedOperationError, isHttpClientResponseError, isHttpClientAbortError, isHttpClientNetworkError, isHttpClientRequestError, } from './lib/types';
-export { AbortController as PlatformAbortController, AbortSignal as PlatformAbortSignal, BaseError as PlatformBaseError, Binary as PlatformBinary, DataTypeError as PlatformDataTypeError, HttpClient as PlatformHttpClient, HttpClientAbortError as PlatformHttpClientAbortError, HttpClientRequestError as PlatformHttpClientRequestError, HttpClientResponse as PlatformHttpClientResponse, HttpClientResponseError as PlatformHttpClientResponseError, UnsupportedOperationError as PlatformUnsupportedOperationError, httpClient, } from './lib/platform';
+export { AbortController as PlatformAbortController, AbortSignal as PlatformAbortSignal, BaseError as PlatformBaseError, Binary as PlatformBinary, DataTypeError as PlatformDataTypeError, HttpClient as PlatformHttpClient, HttpClientAbortError as PlatformHttpClientAbortError, HttpClientRequestError as PlatformHttpClientRequestError, HttpClientResponse as PlatformHttpClientResponse, HttpClientResponseError as PlatformHttpClientResponseError, OAuthHttpClient as _OAuthHttpClient, OAuthHttpClientConfig as _OAuthHttpClientConfig, UnsupportedOperationError as PlatformUnsupportedOperationError, httpClient, } from './lib/platform';

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

 import * as types from '../types';
+import { Headers } from '../types';
+interface HttpClientConfiguration {
+    baseUrl?: string;
+    defaultHeaders?: Headers;
+}
 export declare class HttpClient implements types.HttpClient {
+    private _baseUrl;
+    private _defaultHeaders;
+    constructor(options?: HttpClientConfiguration);
+    /**
+     * Sets HTTP Client Instance baseUrl param to the incoming value `baseUrl`.
+     * @param baseUrl  Base URL used in the request path.
+     */
+    _setBaseURL(baseUrl: string): void;
+    /**
+     * Sets HTTP Client Instance defaultHeaders param to the incoming value `defaultHeaders`.
+     * @param defaultHeaders  HTTP Headers to be used in outgoing requests.
+     */
+    _setDefaultHeaders(defaultHeaders: Headers): void;
     send<T extends keyof types.RequestBodyTypes = 'json'>(options: types.HttpClientRequestOptions<T>): Promise<types.HttpClientResponse>;
 }
 export declare const httpClient: HttpClient;
+export {};

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

@@ -11,2 +11,3 @@ export * from './abort-controller';
 export * from './http-client-response-error';
+export * from './oauth-http-client';
 export * from './unsupported-operation-error';

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

215688

increased by1.26%

Number of package files

137

increased by0.74%

Lines of code

4346

increased by1.54%

Number of lines in readme file

840

increased by2.69%

Dependency changes

• Updated@dynatrace-sdk/http-client@^1.2.0