Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More →
@dynatrace-sdk/client-app-engine-registry
Advanced tools
@dynatrace-sdk/client-app-engine-registry - npm Package Compare versions
Comparing version 1.2.2 to 1.2.3
@@ -5,2 +5,8 @@ # AppEngine - Registry | ||
| ## 1.2.3 | ||
| ### Patch Changes | ||
| - Update documentation | ||
| ## 1.2.2 | ||
@@ -7,0 +13,0 @@ |
848
docs/DOCS.md
@@ -38,3 +38,3 @@ --- | ||
| <div class="col" style={{textAlign: 'right'}}> | ||
| <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry/v/1.2.2">v1.2.2</a> | ||
| <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry/v/1.2.3">v1.2.3</a> | ||
| </div> | ||
@@ -64,51 +64,15 @@ </div> | ||
| **Parameters** | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config</strong>: Object | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a> | ||
| <div class="padding-left--md"> | ||
| #### Parameters | ||
| </div> | ||
| | Name | Type | Description | | ||
| | ------------------------------ | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | config.addFields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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>isolatedUri</code></li> </ul> | | ||
| | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The unique identifier for the app | | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config.addFields</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| Comma-separated list of field names that are added to the default set of fields. | ||
| You can include the following additional fields: | ||
| - `resourceContext` | ||
| - `resourceStatus.subResourceStatuses` | ||
| - `manifest` | ||
| - `isolatedUri` | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config.id</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The unique identifier for the app | ||
| </div> | ||
| </div> | ||
| #### Returns | ||
| <div class="padding-left--md"> | ||
| OK | ||
| </div> | ||
| <details> | ||
@@ -133,4 +97,2 @@ <summary> | ||
| </div> | ||
| ### getApps | ||
@@ -147,42 +109,14 @@ | ||
| **Parameters** | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config</strong>: Object | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a> | ||
| <div class="padding-left--md"> | ||
| #### Parameters | ||
| </div> | ||
| | Name | Type | Description | | ||
| | ---------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | config.addFields | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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>isolatedUri</code></li> </ul> | | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config.addFields</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| Comma-separated list of field names that are added to the default set of fields. | ||
| You can include the following additional fields: | ||
| - `resourceContext` | ||
| - `resourceStatus.subResourceStatuses` | ||
| - `manifest` | ||
| - `isolatedUri` | ||
| </div> | ||
| </div> | ||
| #### Returns | ||
| <div class="padding-left--md"> | ||
| OK | ||
| </div> | ||
| <details> | ||
@@ -206,4 +140,2 @@ <summary> | ||
| </div> | ||
| ### installApp | ||
@@ -224,33 +156,14 @@ | ||
| **Parameters** | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config</strong>: Object | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a> | ||
| <div class="padding-left--md"> | ||
| #### Parameters | ||
| </div> | ||
| | Name | Type | | ||
| | -------------------------------- | ------------------------ | | ||
| | config.body<sup>\*required</sup> | <a href="#blob">Blob</a> | | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config.body</strong>: <a href="#blob">Blob</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| #### Returns | ||
| <div class="padding-left--md"> | ||
| Accepted; new app will be installed/updated | ||
| </div> | ||
| <details> | ||
@@ -274,4 +187,2 @@ <summary> | ||
| </div> | ||
| ### searchActions | ||
@@ -288,39 +199,14 @@ | ||
| **Parameters** | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config</strong>: Object | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a> | ||
| <div class="padding-left--md"> | ||
| #### Parameters | ||
| </div> | ||
| | Name | Type | Description | | ||
| | ------------ | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | config.query | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <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> | | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config.query</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| 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. | ||
| Search terms are case insensitive and each additional search term restricts actions further. | ||
| Maximum length is 256 characters. | ||
| </div> | ||
| </div> | ||
| #### Returns | ||
| <div class="padding-left--md"> | ||
| OK | ||
| </div> | ||
| <details> | ||
@@ -344,4 +230,2 @@ <summary> | ||
| </div> | ||
| ### uninstallApp | ||
@@ -358,28 +242,10 @@ | ||
| **Parameters** | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config</strong>: Object | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config.abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a> | ||
| <div class="padding-left--md"> | ||
| #### Parameters | ||
| </div> | ||
| | Name | Type | Description | | ||
| | ------------------------------ | ----------------------------------------------------------------------------- | --------------------------------- | | ||
| | config.id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The unique identifier for the app | | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>config.id</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The unique identifier for the app | ||
| </div> | ||
| </div> | ||
| <!-- no returns --> | ||
@@ -403,4 +269,2 @@ | ||
| </div> | ||
| ## appEngineRegistrySchemaManifestClient | ||
@@ -421,19 +285,10 @@ | ||
| **Parameters** | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <!-- no parameters --> | ||
| #### Returns | ||
| <div class="padding-left--md"> | ||
| OK | ||
| </div> | ||
| <details> | ||
@@ -455,4 +310,2 @@ <summary> | ||
| </div> | ||
| ### getDefaultCspProperties | ||
@@ -467,19 +320,10 @@ | ||
| **Parameters** | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>abortSignal</strong>: <a href="https://developer.mozilla.org/en-US/docs/Web/API/AbortSignal">AbortSignal</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <!-- no parameters --> | ||
| #### Returns | ||
| <div class="padding-left--md"> | ||
| OK | ||
| </div> | ||
| <details> | ||
@@ -502,4 +346,2 @@ <summary> | ||
| </div> | ||
| ## Types | ||
@@ -509,649 +351,197 @@ | ||
| <div class="padding-left--md"> | ||
| Default Content Security Policies for apps. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>policyDirectives</strong>: <a href="#appdefaultcsppolicydirectives">AppDefaultCspPolicyDirectives</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | | ||
| | ------------------------------------- | -------------------------------------------------------------------------- | | ||
| | policyDirectives<sup>\*required</sup> | <a href="#appdefaultcsppolicydirectives">AppDefaultCspPolicyDirectives</a> | | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### AppDefaultCspPolicyDirectives | ||
| <div class="padding-left--md"> | ||
| The policy directives | ||
| </div> | ||
| ### AppIcon | ||
| <div class="padding-left--md"> | ||
| Representation of an app icon. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>href</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ------------------------- | ----------------------------------------------------------------------------- | ---------------------------- | | ||
| | href<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The reference to an app icon | | ||
| The reference to an app icon | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### AppInfo | ||
| <div class="padding-left--md"> | ||
| A minimal representation of an app. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>appIcon</strong>: <a href="#appicon">AppIcon</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ------------------------------------- | ---------------------------------------------------------------------------------------- | -------------------------- | | ||
| | appIcon | <a href="#appicon">AppIcon</a> | | | ||
| | description<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The description of the app | | ||
| | id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The id of the app | | ||
| | isolatedUri | <a href="#appisolateduri">AppIsolatedUri</a> | | | ||
| | manifest | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | | | ||
| | modificationInfo<sup>\*required</sup> | <a href="#modificationinfo">ModificationInfo</a> | | | ||
| | name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The name of the app | | ||
| | resourceContext | <a href="#resourcecontext">ResourceContext</a> | | | ||
| | resourceStatus<sup>\*required</sup> | <a href="#resourcestatus">ResourceStatus</a> | | | ||
| | signatureInfo<sup>\*required</sup> | <a href="#appsignatureinfo">AppSignatureInfo</a> | | | ||
| | version<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The version of the app | | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>description</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The description of the app | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>id</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The id of the app | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>isolatedUri</strong>: <a href="#appisolateduri">AppIsolatedUri</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>manifest</strong>: <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>modificationInfo</strong>: <a href="#modificationinfo">ModificationInfo</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>name</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The name of the app | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>resourceContext</strong>: <a href="#resourcecontext">ResourceContext</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>resourceStatus</strong>: <a href="#resourcestatus">ResourceStatus</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>signatureInfo</strong>: <a href="#appsignatureinfo">AppSignatureInfo</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>version</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The version of the app | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### AppInfoList | ||
| <div class="padding-left--md"> | ||
| A list of minimal app representations. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>apps</strong>: Array<<a href="#appinfo">AppInfo</a>> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ------------------------- | ------------------------------------------- | ---------------------------------------- | | ||
| | apps<sup>\*required</sup> | Array<<a href="#appinfo">AppInfo</a>> | The list of minimal app representations. | | ||
| The list of minimal app representations. | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### AppIsolatedUri | ||
| <div class="padding-left--md"> | ||
| Representation of an app's isolated uri. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>baseUrl</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ------------------------------ | ----------------------------------------------------------------------------- | ---------------------------------- | | ||
| | baseUrl<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The base URL of an app | | ||
| | url<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The URL of an app | | ||
| | widgetUrl<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The base URL for widgets of an app | | ||
| The base URL of an app | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>url</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The URL of an app | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>widgetUrl</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The base URL for widgets of an app | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### AppSignatureInfo | ||
| <div class="padding-left--md"> | ||
| Representation of an app's signature verification. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>publisher</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | --------------------------- | ------------------------------------------------------------------------------- | -------------------------------------------------- | | ||
| | publisher | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The organization name of the app publisher. | | ||
| | signed<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | App is signed and its signature has been verified. | | ||
| The organization name of the app publisher. | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>signed</strong>: boolean | ||
| <div class="padding-left--md"> | ||
| App is signed and its signature has been verified. | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### AppStub | ||
| <div class="padding-left--md"> | ||
| A minimal representation of an installed/updated app. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>id</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ----------------------- | ----------------------------------------------------------------------------- | ------------------------------- | | ||
| | id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Id of the installed/updated app | | ||
| Id of the installed/updated app | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### ConstraintViolation | ||
| <div class="padding-left--md"> | ||
| Contains information about a constraint violation caused by invalid input. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ---------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------- | | ||
| | message<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The error message | | ||
| | path<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The path of the property that caused the constraint violation | | ||
| The error message | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>path</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The path of the property that caused the constraint violation | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### Error | ||
| <div class="padding-left--md"> | ||
| Contains information for 4xx and 5xx errors. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>code</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ---------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------- | | ||
| | code<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | The HTTP status code | | ||
| | details | <a href="#errordetails">ErrorDetails</a> | | | ||
| | help | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Additional information related to the error | | ||
| | message<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The error message | | ||
| The HTTP status code | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>details</strong>: <a href="#errordetails">ErrorDetails</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>help</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| Additional information related to the error | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The error message | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### ErrorDetails | ||
| <div class="padding-left--md"> | ||
| Contains details for 4xx and 5xx errors. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>constraintViolations</strong>: Array<<a href="#constraintviolation">ConstraintViolation</a>> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | -------------------- | -------------------------------------------------------------------------------------------- | -------------------------------------- | | ||
| | constraintViolations | Array<<a href="#constraintviolation">ConstraintViolation</a>> | A list of constraint violations | | ||
| | errorCode | <a href="#maxnumberofinstalledcustomappsexceeded">MaxNumberOfInstalledCustomAppsExceeded</a> | | | ||
| | errorCodeProperties | <a href="#errordetailserrorcodeproperties">ErrorDetailsErrorCodeProperties</a> | | | ||
| | errorRef | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Generated unique value for 5xx errors. | | ||
| A list of constraint violations | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>errorCode</strong>: <a href="#maxnumberofinstalledcustomappsexceeded">MaxNumberOfInstalledCustomAppsExceeded</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>errorCodeProperties</strong>: <a href="#errordetailserrorcodeproperties">ErrorDetailsErrorCodeProperties</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>errorRef</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| Generated unique value for 5xx errors. | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### ErrorDetailsErrorCodeProperties | ||
| <div class="padding-left--md"> | ||
| Additional properties related to the provided error code | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>customAppLimit</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | -------------- | ----------------------------------------------------------------------------- | --------------------------------------------------------- | | ||
| | customAppLimit | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Limit for max amount of installed custom apps in a tenant | | ||
| Limit for max amount of installed custom apps in a tenant | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### ErrorEnvelope | ||
| <div class="padding-left--md"> | ||
| Error response for all 4xx and 5xx errors. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>error</strong>: <a href="#error">Error</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | | ||
| | -------------------------- | -------------------------- | | ||
| | error<sup>\*required</sup> | <a href="#error">Error</a> | | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### ModificationInfo | ||
| <div class="padding-left--md"> | ||
| Modification information about the app | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>createdAt</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ----------------------------------- | ----------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------- | | ||
| | createdAt<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Timestamp when the resource was created in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | ||
| | createdBy<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | UserId of the user that created the resource | | ||
| | lastModifiedAt<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Timestamp when the resource was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | ||
| | lastModifiedBy<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | UserId of the user that last modified the resource | | ||
| Timestamp when the resource was created in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>createdBy</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| UserId of the user that created the resource | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>lastModifiedAt</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| Timestamp when the resource was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>lastModifiedBy</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| UserId of the user that last modified the resource | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### ResourceContext | ||
| <div class="padding-left--md"> | ||
| Additional resource context information | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>operations</strong>: Array<<a href="#resourcecontextoperationsitem">ResourceContextOperationsItem</a>> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ---------- | --------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | operations | Array<<a href="#resourcecontextoperationsitem">ResourceContextOperationsItem</a>> | <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> | | ||
| Operations that are allowed on the app depending on the user's permissions. | ||
| - `run`: user is allowed to run the app. | ||
| - `update`: user is allowed to update the app. | ||
| - `uninstall`: user is allowed to uninstall the app. | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### ResourceStatus | ||
| <div class="padding-left--md"> | ||
| The status of the app plus additional details. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>operationStateBeforeError</strong>: <a href="#resourcestatusoperationstatebeforeerror">ResourceStatusOperationStateBeforeError</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | --------------------------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------- | | ||
| | operationStateBeforeError | <a href="#resourcestatusoperationstatebeforeerror">ResourceStatusOperationStateBeforeError</a> | | | ||
| | pendingOperation | <a href="#resourcestatuspendingoperation">ResourceStatusPendingOperation</a> | | | ||
| | status<sup>\*required</sup> | <a href="#resourcestatusstatus">ResourceStatusStatus</a> | | | ||
| | subResourceStatuses | Array<<a href="#subresourcestatus">SubResourceStatus</a>> | The statuses of the app's sub resources. | | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>pendingOperation</strong>: <a href="#resourcestatuspendingoperation">ResourceStatusPendingOperation</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>status</strong>: <a href="#resourcestatusstatus">ResourceStatusStatus</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>subResourceStatuses</strong>: Array<<a href="#subresourcestatus">SubResourceStatus</a>> | ||
| <div class="padding-left--md"> | ||
| The statuses of the app's sub resources. | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### SearchAppAction | ||
| <div class="padding-left--md"> | ||
| List of apps with actions. Apps are sorted by name in ascending order. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>actions</strong>: Array<<a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a>> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ---------------------------- | ----------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | ||
| | actions<sup>\*required</sup> | Array<<a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a>> | List of app actions. Actions are sorted by name in ascending order. Actions without name are last. | | ||
| | id<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | App id | | ||
| | name<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | App name | | ||
| List of app actions. Actions are sorted by name in ascending order. Actions without name are last. | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>id</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| App id | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>name</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| App name | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### SearchAppActionList | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ------------------------------- | ----------------------------------------------------------------------------- | -------------------- | | ||
| | apps<sup>\*required</sup> | Array<<a href="#searchappaction">SearchAppAction</a>> | | | ||
| | totalCount<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Total actions count. | | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>apps</strong>: Array<<a href="#searchappaction">SearchAppAction</a>> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>totalCount</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | ||
| <div class="padding-left--md"> | ||
| Total actions count. | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### SubResourceConstraintViolation | ||
| <div class="padding-left--md"> | ||
| Contains information about a constraint violation caused by invalid input. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ---------------------------- | ----------------------------------------------------------------------------- | ------------------------------------------------------------- | | ||
| | message<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The error message | | ||
| | path | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The path of the property that caused the constraint violation | | ||
| The error message | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>path</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The path of the property that caused the constraint violation | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### SubResourceError | ||
| <div class="padding-left--md"> | ||
| Additional error information that can be present if the sub resource `status` is `FAILED` | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>constraintViolations</strong>: Array<<a href="#subresourceconstraintviolation">SubResourceConstraintViolation</a>> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | Description | | ||
| | ---------------------------- | ----------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------ | | ||
| | constraintViolations | Array<<a href="#subresourceconstraintviolation">SubResourceConstraintViolation</a>> | A list of constraint violations | | ||
| | errorCode | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | An error code that can be used determine the nature of an error and why it occurred. | | ||
| | errorRef | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | Optional generated unique value to reference this error. | | ||
| | message<sup>\*required</sup> | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The error message. | | ||
| A list of constraint violations | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>errorCode</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| An error code that can be used determine the nature of an error and why it occurred. | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>errorRef</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| Optional generated unique value to reference this error. | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>message</strong>: <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | ||
| <div class="padding-left--md"> | ||
| The error message. | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ### SubResourceStatus | ||
| <div class="padding-left--md"> | ||
| The status of the sub resource. | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>error</strong>: <a href="#subresourceerror">SubResourceError</a> | ||
| <div class="padding-left--md"> | ||
| | Name | Type | | ||
| | ------------------------------------ | -------------------------------------------------------------------------------- | | ||
| | error | <a href="#subresourceerror">SubResourceError</a> | | ||
| | status<sup>\*required</sup> | <a href="#subresourcestatusstatus">SubResourceStatusStatus</a> | | ||
| | subResourceType<sup>\*required</sup> | <a href="#subresourcestatussubresourcetype">SubResourceStatusSubResourceType</a> | | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>status</strong>: <a href="#subresourcestatusstatus">SubResourceStatusStatus</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| <div class="padding-left--md padding-bottom--md"> | ||
| <strong>subResourceType</strong>: <a href="#subresourcestatussubresourcetype">SubResourceStatusSubResourceType</a> | ||
| <div class="padding-left--md"> | ||
| </div> | ||
| </div> | ||
| </div> | ||
| ## Enums | ||
@@ -1158,0 +548,0 @@ |
| { | ||
| "name": "@dynatrace-sdk/client-app-engine-registry", | ||
| "version": "1.2.2", | ||
| "version": "1.2.3", | ||
| "dependencies": { | ||
@@ -5,0 +5,0 @@ "@dynatrace-sdk/http-client": "^1.0.3" |
| # @dynatrace-sdk/client-app-engine-registry | ||
| [](https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry/v/1.2.2) | ||
| [](https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry/v/1.2.3) | ||
| [](https://opensource.org/licenses/Apache-2.0) | ||
@@ -5,0 +5,0 @@ |
New alerts
License Policy Violation
LicenseThis 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
LicenseThis 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
- increased by2%
184956
No dependency changes