@dynatrace-sdk/client-app-settings - npm Package Compare versions

Comparing version 1.8.0 to 1.9.0

CHANGELOG.md

@@ -5,2 +5,8 @@ # App Settings
 
+## 1.9.0
+
+### Minor Changes
+
+- add error object to settings objects response for incomplete responses.
+
 ## 1.8.0
@@ -7,0 +13,0 @@

dynatrace-metadata.json

 {
   "dynagen": {
-    "version": "0.15.2",
+    "version": "0.15.4",
     "generatedAt": "",
@@ -12,5 +12,5 @@ "template": {
     "title": "App Settings",
-    "version": "1.2.0",
+    "version": "1.3.0",
     "baseUrl": "/platform/app-settings/v1"
   }
 }

package.json

 {
   "name": "@dynatrace-sdk/client-app-settings",
-  "version": "1.8.0",
+  "version": "1.9.0",
   "description": "Retrieve, update and manage app settings.",
@@ -5,0 +5,0 @@ "license": "Apache-2.0",

README.md

 # @dynatrace-sdk/client-app-settings
 
-[![npm](https://img.shields.io/badge/npm-v1.8.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-app-settings/v/1.8.0)
+[![npm](https://img.shields.io/badge/npm-v1.9.0-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-app-settings/v/1.9.0)
 [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
@@ -207,5 +207,9 @@
 |---|---|---|
-|[AppSettingsObjectsList](#appsettingsobjectslist)|200|Success. Accessible objects returned.|
+|[AppSettingsObjectsList](#appsettingsobjectslist)|200|Success. Accessible objects returned. 
 
+ Even if a response returns a successful response code it is possible that the result is incomplete due to an internal error. 
 
+ In this case an 'error' property with information about the problem is added. The caller may decide to work with the incomplete result or do a retry of the operation.|
+
+
 #### Throws
@@ -276,5 +280,9 @@
 |---|---|---|
-|[EffectiveAppSettingsValuesList](#effectiveappsettingsvalueslist)|200|Success|
+|[EffectiveAppSettingsValuesList](#effectiveappsettingsvalueslist)|200|Success 
 
+ Even if a response returns a successful response code it is possible that the result is incomplete due to an internal error. 
 
+ In this case an 'error' property with information about the problem is added. The caller may decide to work with the incomplete result or do a retry of the operation.|
+
+
 #### Throws
@@ -534,2 +542,12 @@
 
+### AppSettingsErrorIncomplete
+
+Error object for an incomplete response
+
+| Name | Type | Description |
+| --- | --- | --- |
+|code|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code |
+|details|<a href="#appsettingserrordetails" target="_blank" rel="noopener noreferrer">AppSettingsErrorDetails</a>|The error details |
+|message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message |
+
 ### AppSettingsModificationInfo
@@ -552,5 +570,5 @@
 | --- | --- | --- |
-|modificationInfo|<a href="#appsettingsmodificationinfo" target="_blank" rel="noopener noreferrer">AppSettingsModificationInfo</a>|Modification information about the app setting. |
+|modificationInfo|<a href="#appsettingsmodificationinfo">AppSettingsModificationInfo</a>|Modification information about the app setting. |
 |objectId<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The ID of the settings object. |
-|resourceContext|<a href="#resourcecontext">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
+|resourceContext|<a href="#resourcecontext" target="_blank" rel="noopener noreferrer">ResourceContext</a>|The resource context, which contains additional permission information about the object. |
 |schemaId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The schema on which the object is based. |
@@ -598,2 +616,3 @@ |schemaVersion|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the schema on which the object is based. |
 | --- | --- | --- |
+|error|<a href="#appsettingserrorincomplete">AppSettingsErrorIncomplete</a>|Error object for an incomplete response |
 |items<sup>*required</sup>|Array&lt;<a href="#appsettingsobject" target="_blank" rel="noopener noreferrer">AppSettingsObject</a>&gt;|A list of settings objects. |
@@ -634,3 +653,4 @@ |nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p>  |
 | --- | --- | --- |
-|items<sup>*required</sup>|Array&lt;<a href="#effectiveappsettingsvalue" target="_blank" rel="noopener noreferrer">EffectiveAppSettingsValue</a>&gt;|A list of effective settings values. |
+|error|<a href="#appsettingserrorincomplete" target="_blank" rel="noopener noreferrer">AppSettingsErrorIncomplete</a>|Error object for an incomplete response |
+|items<sup>*required</sup>|Array&lt;<a href="#effectiveappsettingsvalue">EffectiveAppSettingsValue</a>&gt;|A list of effective settings values. |
 |nextPageKey|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|<p>The cursor for the next page of results. Has the value of <code>null</code> on the last page.</p> <p>Use it in the <strong>nextPageKey</strong> query parameter to obtain subsequent pages of the result.</p>  |
@@ -644,3 +664,3 @@ |pageSize<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The number of entries per page. |
 | --- | --- |
-|context|<a href="#permissioncontext">PermissionContext</a>| 
+|context|<a href="#permissioncontext" target="_blank" rel="noopener noreferrer">PermissionContext</a>| 
 |granted<sup>*required</sup>|"true" &#124; "false" &#124; "condition"| 
@@ -651,3 +671,3 @@ |permission<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|
 
-**type**: Array&lt;<a href="#effectivepermission" target="_blank" rel="noopener noreferrer">EffectivePermission</a>&gt;
+**type**: Array&lt;<a href="#effectivepermission">EffectivePermission</a>&gt;
 
@@ -675,3 +695,3 @@ ### Modifications
 | --- | --- |
-|permissions<sup>*required</sup>|Array&lt;<a href="#singlepermissionrequest">SinglePermissionRequest</a>&gt;|
+|permissions<sup>*required</sup>|Array&lt;<a href="#singlepermissionrequest" target="_blank" rel="noopener noreferrer">SinglePermissionRequest</a>&gt;|
 
@@ -684,3 +704,3 @@ ### ResourceContext
 | --- | --- | --- |
-|modifications<sup>*required</sup>|<a href="#modifications" target="_blank" rel="noopener noreferrer">Modifications</a>|The additional modification details for this settings object. |
+|modifications<sup>*required</sup>|<a href="#modifications">Modifications</a>|The additional modification details for this settings object. |
 |operations<sup>*required</sup>|Array&lt;"read" &#124; "write" &#124; "delete"&gt;|The allowed operations on this settings object. |
@@ -694,3 +714,3 @@
 | --- | --- |
-|context|<a href="#permissioncontext">PermissionContext</a>| 
+|context|<a href="#permissioncontext" target="_blank" rel="noopener noreferrer">PermissionContext</a>| 
 |permission<sup>*required</sup>|"app-settings:objects:read" &#124; "app-settings:objects:write"|
@@ -697,0 +717,0 @@

types/packages/client/app-settings/src/lib/apis/app-settings-objects-api.d.ts

@@ -119,2 +119,6 @@ import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
      *
+     *  Even if a response returns a successful response code it is possible that the result is incomplete due to an internal error.
+     *
+     *  In this case an 'error' property with information about the problem is added. The caller may decide to work with the incomplete result or do a retry of the operation.
+     *
      * @example <caption>Code example</caption>
@@ -197,2 +201,6 @@ * import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings";
      *
+     *  Even if a response returns a successful response code it is possible that the result is incomplete due to an internal error.
+     *
+     *  In this case an 'error' property with information about the problem is added. The caller may decide to work with the incomplete result or do a retry of the operation.
+     *
      * @example <caption>Code example</caption>
@@ -199,0 +207,0 @@ * import { appSettingsObjectsClient } from "@dynatrace-sdk/client-app-settings";

types/packages/client/app-settings/src/lib/models/app-settings-objects-list.d.ts

@@ -0,1 +1,2 @@
+import { AppSettingsErrorIncomplete } from './app-settings-error-incomplete';
 import { AppSettingsObject } from './app-settings-object';
@@ -24,2 +25,6 @@ /**
     items: AppSettingsObject[];
+    /**
+     * Error object for an incomplete response
+     */
+    error?: AppSettingsErrorIncomplete;
 }

types/packages/client/app-settings/src/lib/models/app-settings-objects-list.transformation.d.ts

@@ -0,1 +1,2 @@
+import * as _AppSettingsErrorIncompleteTransformation from './app-settings-error-incomplete.transformation';
 import * as _AppSettingsObjectTransformation from './app-settings-object.transformation';
@@ -8,4 +9,5 @@ import { AppSettingsObjectsList } from './app-settings-objects-list';
     items: _AppSettingsObjectTransformation.AsJson[];
+    error?: _AppSettingsErrorIncompleteTransformation.AsJson;
 }
 export declare function fromJson($model: AsJson): AppSettingsObjectsList;
 export declare function toJson($model: AppSettingsObjectsList): AsJson;

types/packages/client/app-settings/src/lib/models/effective-app-settings-values-list.d.ts

@@ -0,1 +1,2 @@
+import { AppSettingsErrorIncomplete } from './app-settings-error-incomplete';
 import { EffectiveAppSettingsValue } from './effective-app-settings-value';
@@ -24,2 +25,6 @@ /**
     items: EffectiveAppSettingsValue[];
+    /**
+     * Error object for an incomplete response
+     */
+    error?: AppSettingsErrorIncomplete;
 }

types/packages/client/app-settings/src/lib/models/effective-app-settings-values-list.transformation.d.ts

@@ -0,1 +1,2 @@
+import * as _AppSettingsErrorIncompleteTransformation from './app-settings-error-incomplete.transformation';
 import * as _EffectiveAppSettingsValueTransformation from './effective-app-settings-value.transformation';
@@ -8,4 +9,5 @@ import { EffectiveAppSettingsValuesList } from './effective-app-settings-values-list';
     items: _EffectiveAppSettingsValueTransformation.AsJson[];
+    error?: _AppSettingsErrorIncompleteTransformation.AsJson;
 }
 export declare function fromJson($model: AsJson): EffectiveAppSettingsValuesList;
 export declare function toJson($model: EffectiveAppSettingsValuesList): AsJson;

types/packages/client/app-settings/src/lib/models/index.d.ts

@@ -7,2 +7,4 @@ export * from './app-settings-error';
 export * as _AppSettingsErrorEnvelopeTransformation from './app-settings-error-envelope.transformation';
+export * from './app-settings-error-incomplete';
+export * as _AppSettingsErrorIncompleteTransformation from './app-settings-error-incomplete.transformation';
 export * from './app-settings-modification-info';
@@ -9,0 +11,0 @@ export * as _AppSettingsModificationInfoTransformation from './app-settings-modification-info.transformation';

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

277355

increased by2.77%

Number of package files

129

increased by1.57%

Lines of code

6197

increased by2.03%

Number of lines in readme file

780

increased by2.63%

No dependency changes