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.6.2 to 1.7.1
@@ -5,2 +5,21 @@ # AppEngine - Registry | ||
| ## 1.7.1 | ||
| ### Patch Changes | ||
| - Add API reference to the readme file | ||
| ## 1.7.0 | ||
| ### Minor Changes | ||
| - add sub-resource type for documents | ||
| ## 1.6.3 | ||
| ### Patch Changes | ||
| - Update http-client | ||
| - Sanitize links in the documentation. | ||
| ## 1.6.2 | ||
@@ -7,0 +26,0 @@ |
@@ -885,11 +885,21 @@ /** | ||
| }; | ||
| var addArrayQueryParam = (query, key) => { | ||
| var addExplodedArrayQueryParam = (query, key) => { | ||
| const arrayValue = query[key]; | ||
| return arrayValue.map((value) => encodeQueryParam(key, value)).join("&"); | ||
| }; | ||
| var addNonExplodedArrayQueryParams = (query, key) => { | ||
| const encodedKey = encodeURIComponent(key); | ||
| const encodedParamsList = query[key].map((value) => encodeURIComponent(typeof value === "number" ? value : String(value))).join(","); | ||
| return `${encodedKey}=${encodedParamsList}`; | ||
| }; | ||
| var addQueryParam = (query, key) => encodeQueryParam(key, query[key]); | ||
| var toQueryString = (rawQuery) => { | ||
| var arrayQueryParams = (query, key, explode) => { | ||
| return explode ? addExplodedArrayQueryParam(query, key) : addNonExplodedArrayQueryParams(query, key); | ||
| }; | ||
| var toQueryString = (rawQuery, flags = {}) => { | ||
| const query = rawQuery || {}; | ||
| const keys = Object.keys(query).filter((key) => typeof query[key] !== "undefined"); | ||
| const queryString = keys.map((key) => Array.isArray(query[key]) ? addArrayQueryParam(query, key) : addQueryParam(query, key)).join("&"); | ||
| const queryString = keys.map( | ||
| (key) => Array.isArray(query[key]) ? arrayQueryParams(query, key, flags.explode?.hasOwnProperty(key) ? flags.explode[key] : true) : addQueryParam(query, key) | ||
| ).join("&"); | ||
| return queryString ? `?${queryString}` : ""; | ||
@@ -1372,3 +1382,4 @@ }; | ||
| SubResourceStatusSubResourceType2["SettingsSchemas"] = "SETTINGS_SCHEMAS"; | ||
| SubResourceStatusSubResourceType2["Documents"] = "DOCUMENTS"; | ||
| return SubResourceStatusSubResourceType2; | ||
| })(SubResourceStatusSubResourceType || {}); |
457
docs/DOCS.md
@@ -9,33 +9,23 @@ --- | ||
| ## Overview | ||
| The Registry is mainly responsible for | ||
| * installing / updating / storing apps | ||
| * uninstalling / removing apps | ||
| * getting apps | ||
| ### Asynchronous behavior | ||
| Both the install and the uninstall process are performed asynchronously. The Registry persists | ||
| the app bundle and defines the desired state of the app (e.g. installed, uninstalled). The | ||
| installation / uninstallation process is then handled asynchronously by a separate service. | ||
| The Registry is mainly responsible for | ||
| The current status of the app is provided by the status in the response body of the | ||
| respective GET request, e.g. `/apps/{id}`. | ||
| - installing / updating / storing apps | ||
| - uninstalling / removing apps | ||
| - getting apps | ||
| ### Asynchronous behavior | ||
| import NpmLogo from '@site/static/img/npm-logo.png'; | ||
| Both the install and the uninstall process are performed asynchronously. The Registry persists | ||
| the app bundle and defines the desired state of the app (e.g. installed, uninstalled). The | ||
| installation / uninstallation process is then handled asynchronously by a separate service. | ||
| The current status of the app is provided by the status in the response body of the | ||
| respective GET request, e.g. `/apps/{id}`. | ||
| import NpmLogo from "@site/static/img/npm-logo.png"; | ||
| <div class="row margin-bottom--md"> | ||
| <div class="col"> | ||
| <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry"> | ||
| <span class="margin-right--xs"> | ||
| @dynatrace-sdk/client-app-engine-registry | ||
| </span> | ||
| <img className="no-zoom" width="20px" src={NpmLogo} /> | ||
| </a> | ||
| <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry" target="_blank" rel="noopener noreferrer"> <span class="margin-right--xs">@dynatrace-sdk/client-app-engine-registry</span> <img className="no-zoom" width="20px" src={NpmLogo} /> </a> | ||
| </div> | ||
| <div class="col" style={{ textAlign: "right" }}> | ||
| <a href="https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry/v/1.6.2"> | ||
| v1.6.2 | ||
| </a> | ||
| <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> | ||
| </div> | ||
@@ -51,9 +41,10 @@ </div> | ||
| ```js | ||
| import { appEngineRegistryAppsClient } from "@dynatrace-sdk/client-app-engine-registry"; | ||
| import { appEngineRegistryAppsClient } from '@dynatrace-sdk/client-app-engine-registry'; | ||
| ``` | ||
| ### getApp | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistryAppsClient.getApp(config): Promise<<a href="#appinfo">AppInfo</a>></strong> | ||
| <strong>appEngineRegistryAppsClient.getApp(config): Promise<[AppInfo](#appinfo)></strong> | ||
@@ -68,11 +59,17 @@ <div class="padding-left--md"> | ||
| </div> | ||
| #### Parameters | ||
| | 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>isBuiltin</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 | | ||
| | 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> | | ||
| |config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier for the app | | ||
| #### Returns | ||
@@ -82,2 +79,3 @@ | ||
| <details> | ||
@@ -99,8 +97,11 @@ <summary> | ||
| </div> | ||
| ### getApps | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistryAppsClient.getApps(config): Promise<<a href="#appinfolist">AppInfoList</a>></strong> | ||
| <strong>appEngineRegistryAppsClient.getApps(config): Promise<[AppInfoList](#appinfolist)></strong> | ||
@@ -113,13 +114,19 @@ <div class="padding-left--md"> | ||
| </div> | ||
| #### Parameters | ||
| | 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>isBuiltin</code></li> <li><code>isolatedUri</code></li> </ul> | | ||
| | config.includeAllAppVersions | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <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> | | ||
| | config.includeDeactivated | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, apps that are <code>DEACTIVATED</code> because of missing entitlements are included in the response. <i>default:</i> <code>false</code> | | ||
| | config.includeNonRunnable | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | If <code>true</code>, apps that the user is not allowed to run because of missing permissions are included in the response. <i>default:</i> <code>false</code> | | ||
| | 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> | | ||
| |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>| | ||
| |config.includeDeactivated|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, apps that are <code>DEACTIVATED</code> because of missing entitlements are included in the response. <i>default:</i> <code>false</code>| | ||
| |config.includeNonRunnable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, apps that the user is not allowed to run because of missing permissions are included in the response. <i>default:</i> <code>false</code>| | ||
| #### Returns | ||
@@ -129,2 +136,3 @@ | ||
| <details> | ||
@@ -144,8 +152,11 @@ <summary> | ||
| </div> | ||
| ### installApp | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistryAppsClient.installApp(config): Promise<<a href="#appstub">AppStub</a>></strong> | ||
| <strong>appEngineRegistryAppsClient.installApp(config): Promise<[AppStub](#appstub)></strong> | ||
@@ -160,12 +171,18 @@ <div class="padding-left--md"> | ||
| _The zipped app bundle has to be provided via the request body_ | ||
| *The zipped app bundle has to be provided via the request body* | ||
| </div> | ||
| #### Parameters | ||
| | Name | Type | | ||
| | -------------------------------- | ---- | | ||
| | config.body<sup>\*required</sup> | Blob | | ||
| | Name | Type| | ||
| |---|---| | ||
| |config.body<sup>*required</sup>|Blob| | ||
| #### Returns | ||
@@ -175,2 +192,3 @@ | ||
| <details> | ||
@@ -192,8 +210,11 @@ <summary> | ||
| </div> | ||
| ### searchActions | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistryAppsClient.searchActions(config): Promise<<a href="#searchappactionlist">SearchAppActionList</a>></strong> | ||
| <strong>appEngineRegistryAppsClient.searchActions(config): Promise<[SearchAppActionList](#searchappactionlist)></strong> | ||
@@ -206,10 +227,16 @@ <div class="padding-left--md"> | ||
| </div> | ||
| #### Parameters | ||
| | 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> | | ||
| | 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> | | ||
| #### Returns | ||
@@ -219,2 +246,3 @@ | ||
| <details> | ||
@@ -229,3 +257,4 @@ <summary> | ||
| const data = await appEngineRegistryAppsClient.searchActions(); | ||
| const data = | ||
| await appEngineRegistryAppsClient.searchActions(); | ||
| ``` | ||
@@ -235,4 +264,7 @@ | ||
| </div> | ||
| ### uninstallApp | ||
@@ -249,12 +281,17 @@ | ||
| </div> | ||
| #### Parameters | ||
| | 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 | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier for the app | | ||
| {/* no returns */} | ||
| <details> | ||
@@ -269,3 +306,5 @@ <summary> | ||
| const data = await appEngineRegistryAppsClient.uninstallApp({ id: "..." }); | ||
| const data = await appEngineRegistryAppsClient.uninstallApp( | ||
| { id: "..." }, | ||
| ); | ||
| ``` | ||
@@ -275,2 +314,4 @@ | ||
| </div> | ||
@@ -281,9 +322,10 @@ | ||
| ```js | ||
| import { appEngineRegistrySchemaManifestClient } from "@dynatrace-sdk/client-app-engine-registry"; | ||
| import { appEngineRegistrySchemaManifestClient } from '@dynatrace-sdk/client-app-engine-registry'; | ||
| ``` | ||
| ### getAppManifestSchema | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistrySchemaManifestClient.getAppManifestSchema(abortSignal?): Promise<Record<<a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | <a href="https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any">any</a>>></strong> | ||
| <strong>appEngineRegistrySchemaManifestClient.getAppManifestSchema(abortSignal?): Promise<Record<[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | [any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)>></strong> | ||
@@ -294,6 +336,8 @@ <div class="padding-left--md"> | ||
| </div> | ||
| {/* no parameters */} | ||
| #### Returns | ||
@@ -303,2 +347,3 @@ | ||
| <details> | ||
@@ -313,3 +358,4 @@ <summary> | ||
| const data = await appEngineRegistrySchemaManifestClient.getAppManifestSchema(); | ||
| const data = | ||
| await appEngineRegistrySchemaManifestClient.getAppManifestSchema(); | ||
| ``` | ||
@@ -319,8 +365,11 @@ | ||
| </div> | ||
| ### getDefaultCspProperties | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistrySchemaManifestClient.getDefaultCspProperties(abortSignal?): Promise<<a href="#appdefaultcsp">AppDefaultCsp</a>></strong> | ||
| <strong>appEngineRegistrySchemaManifestClient.getDefaultCspProperties(abortSignal?): Promise<[AppDefaultCsp](#appdefaultcsp)></strong> | ||
@@ -331,6 +380,8 @@ <div class="padding-left--md"> | ||
| </div> | ||
| {/* no parameters */} | ||
| #### Returns | ||
@@ -340,2 +391,3 @@ | ||
| <details> | ||
@@ -356,2 +408,4 @@ <summary> | ||
| </div> | ||
@@ -363,10 +417,14 @@ | ||
| Default Content Security Policies for apps. | ||
| | Name | Type | | ||
| | ------------------------------------- | -------------------------------------------------------------------------- | | ||
| | policyDirectives<sup>\*required</sup> | <a href="#appdefaultcsppolicydirectives">AppDefaultCspPolicyDirectives</a> | | ||
| | Name | Type| | ||
| |---|---| | ||
| |policyDirectives<sup>*required</sup>|[AppDefaultCspPolicyDirectives](#appdefaultcsppolicydirectives)| | ||
| ### AppDefaultCspPolicyDirectives | ||
| The policy directives | ||
@@ -376,196 +434,238 @@ | ||
| Representation of an app icon. | ||
| | 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 | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |href<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The reference to an app icon | | ||
| ### AppInfo | ||
| A minimal representation of an app. | ||
| | 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 | | ||
| | isBuiltin | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Boolean">boolean</a> | <p>Whether this is a built-in app or not. Built-in apps are provided by Dynatrace and installed on every environment.</p> | | ||
| | isolatedUri | <a href="#appisolateduri">AppIsolatedUri</a> | | | ||
| | manifest | AppInfoManifest | | | ||
| | 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 | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |appIcon|[AppIcon](#appicon)| | | ||
| |description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the app | | ||
| |id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id of the app | | ||
| |isBuiltin|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>Whether this is a built-in app or not. Built-in apps are provided by Dynatrace and installed on every environment.</p> | | ||
| |isolatedUri|[AppIsolatedUri](#appisolateduri)| | | ||
| |manifest|AppInfoManifest| | | ||
| |modificationInfo<sup>*required</sup>|[ModificationInfo](#modificationinfo)| | | ||
| |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the app | | ||
| |resourceContext|[ResourceContext](#resourcecontext)| | | ||
| |resourceStatus<sup>*required</sup>|[ResourceStatus](#resourcestatus)| | | ||
| |signatureInfo<sup>*required</sup>|[AppSignatureInfo](#appsignatureinfo)| | | ||
| |version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the app | | ||
| ### AppInfoList | ||
| A list of minimal app representations. | ||
| | Name | Type | Description | | ||
| | ------------------------- | ------------------------------------------- | ---------------------------------------- | | ||
| | apps<sup>\*required</sup> | Array<<a href="#appinfo">AppInfo</a>> | The list of minimal app representations. | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |apps<sup>*required</sup>|Array<[AppInfo](#appinfo)>|The list of minimal app representations. | | ||
| ### AppIsolatedUri | ||
| Representation of an app's isolated uri. | ||
| | 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 | | ||
| Representation of an app's isolated uri. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |baseUrl<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The base URL of an app | | ||
| |url<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL of an app | | ||
| |widgetUrl<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The base URL for widgets of an app | | ||
| ### AppSignatureInfo | ||
| Representation of an app's signature verification. | ||
| | 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. | | ||
| Representation of an app's signature verification. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |publisher|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The organization name of the app publisher. | | ||
| |signed<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|App is signed and its signature has been verified. | | ||
| ### AppStub | ||
| A minimal representation of an installed/updated app. | ||
| | 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 | | ||
| | warnings | Array<<a href="#warning">Warning</a>> | Contains warning information although the request was successful | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of the installed/updated app | | ||
| |warnings|Array<[Warning](#warning)>|Contains warning information although the request was successful | | ||
| ### ConstraintViolation | ||
| Contains information about a constraint violation caused by invalid input. | ||
| | 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 | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message | | ||
| |path<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The path of the property that caused the constraint violation | | ||
| ### Error | ||
| Contains information for 4xx and 5xx errors. | ||
| | 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 | | ||
| | retryAfterSeconds | <a href="https://developer.mozilla.org/en-US/docs/Glossary/Number">number</a> | Seconds to wait until the next retry | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code | | ||
| |details|[ErrorDetails](#errordetails)| | | ||
| |help|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Additional information related to the error | | ||
| |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message | | ||
| |retryAfterSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Seconds to wait until the next retry | | ||
| ### ErrorDetails | ||
| Contains details for 4xx and 5xx errors. | ||
| | Name | Type | Description | | ||
| | -------------------- | ------------------------------------------------------------------------------ | ------------------------------------------------------- | | ||
| | constraintViolations | Array<<a href="#constraintviolation">ConstraintViolation</a>> | A list of constraint violations | | ||
| | errorCode | MaxNumberOfInstalledCustomAppsExceeded | | | ||
| | 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. | | ||
| | traceId | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | OpenTelemetry trace id of the trace where error occurs. | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |constraintViolations|Array<[ConstraintViolation](#constraintviolation)>|A list of constraint violations | | ||
| |errorCode|MaxNumberOfInstalledCustomAppsExceeded| | | ||
| |errorCodeProperties|[ErrorDetailsErrorCodeProperties](#errordetailserrorcodeproperties)| | | ||
| |errorRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Generated unique value for 5xx errors. | | ||
| |traceId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|OpenTelemetry trace id of the trace where error occurs. | | ||
| ### ErrorDetailsErrorCodeProperties | ||
| Additional properties related to the provided error code | ||
| | 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 | | ||
| | 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 | | ||
| ### ErrorEnvelope | ||
| Error response for all 4xx and 5xx errors. | ||
| | Name | Type | | ||
| | -------------------------- | -------------------------- | | ||
| | error<sup>\*required</sup> | <a href="#error">Error</a> | | ||
| | Name | Type| | ||
| |---|---| | ||
| |error<sup>*required</sup>|[Error](#error)| | ||
| ### ModificationInfo | ||
| Modification information about the app | ||
| | 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 | | ||
| | 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') | | ||
| |createdBy<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|UserId of the user that created the resource | | ||
| |lastModifiedAt<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Timestamp when the resource was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | ||
| |lastModifiedBy<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|UserId of the user that last modified the resource | | ||
| ### ResourceContext | ||
| Additional resource context information | ||
| | Name | Type | Description | | ||
| | ---------- | ------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | ||
| | operations | Array<ResourceContextOperationsItem> | <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> | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |operations|Array<ResourceContextOperationsItem>|<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> | | ||
| ### ResourceStatus | ||
| The status of the app plus additional details. | ||
| | Name | Type | Description | | ||
| | --------------------------- | --------------------------------------------------------------- | ---------------------------------------- | | ||
| | operationStateBeforeError | ResourceStatusOperationStateBeforeError | | | ||
| | pendingOperation | ResourceStatusPendingOperation | | | ||
| | status<sup>\*required</sup> | ResourceStatusStatus | | | ||
| | subResourceStatuses | Array<<a href="#subresourcestatus">SubResourceStatus</a>> | The statuses of the app's sub resources. | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |operationStateBeforeError|ResourceStatusOperationStateBeforeError| | | ||
| |pendingOperation|ResourceStatusPendingOperation| | | ||
| |status<sup>*required</sup>|ResourceStatusStatus| | | ||
| |subResourceStatuses|Array<[SubResourceStatus](#subresourcestatus)>|The statuses of the app's sub resources. | | ||
| ### SearchAppAction | ||
| List of apps with actions. Apps are sorted by name in ascending order. | ||
| | Name | Type | Description | | ||
| | ---------------------------- | ----------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------- | | ||
| | actions<sup>\*required</sup> | Array<SearchAppActionActionsItem> | 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 | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |actions<sup>*required</sup>|Array<SearchAppActionActionsItem>|List of app actions. Actions are sorted by name in ascending order. Actions without name are last. | | ||
| |id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|App id | | ||
| |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|App name | | ||
| ### SearchAppActionList | ||
| | 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. | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |apps<sup>*required</sup>|Array<[SearchAppAction](#searchappaction)>| | | ||
| |totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Total actions count. | | ||
| ### SubResourceConstraintViolation | ||
| Contains information about a constraint violation caused by invalid input. | ||
| | 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 | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message | | ||
| |path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The path of the property that caused the constraint violation | | ||
| ### SubResourceError | ||
| Additional error information that can be present if the sub resource `status` is `FAILED` | ||
| | 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. | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |constraintViolations|Array<[SubResourceConstraintViolation](#subresourceconstraintviolation)>|A list of constraint violations | | ||
| |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. | | ||
| |errorRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional generated unique value to reference this error. | | ||
| |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message. | | ||
| ### SubResourceStatus | ||
| The status of the sub resource. | ||
| | Name | Type | | ||
| | ------------------------------------ | ------------------------------------------------ | | ||
| | error | <a href="#subresourceerror">SubResourceError</a> | | ||
| | status<sup>\*required</sup> | SubResourceStatusStatus | | ||
| | subResourceType<sup>\*required</sup> | SubResourceStatusSubResourceType | | ||
| | Name | Type| | ||
| |---|---| | ||
| |error|[SubResourceError](#subresourceerror)| | ||
| |status<sup>*required</sup>|SubResourceStatusStatus| | ||
| |subResourceType<sup>*required</sup>|SubResourceStatusSubResourceType| | ||
| ### Warning | ||
| A warning. | ||
| | Name | Type | Description | | ||
| | ------- | ----------------------------------------------------------------------------- | -------------------- | | ||
| | message | <a href="https://developer.mozilla.org/en-US/docs/Glossary/String">string</a> | The warning message. | | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The warning message. | | ||
@@ -581,5 +681,4 @@ ## Enums | ||
| Possible error codes: | ||
| * `MaxNumberOfInstalledCustomAppsExceeded`: The app bundle could not be uploaded because the max number of custom apps was exceeded. Learn more: https://dt-url.net/upgrade-license | ||
| - `MaxNumberOfInstalledCustomAppsExceeded`: The app bundle could not be uploaded because the max number of custom apps was exceeded. Learn more: https://dt-url.net/upgrade-license | ||
| #### Enum keys | ||
@@ -593,2 +692,3 @@ | ||
| </div> | ||
@@ -600,2 +700,4 @@ | ||
| #### Enum keys | ||
@@ -609,2 +711,3 @@ | ||
| </div> | ||
@@ -616,3 +719,3 @@ | ||
| Details about the state when an error occurred. Only present if the app's `status` is `ERROR`. | ||
| Details about the state when an error occurred. Only present if the app's `status` is `ERROR`. | ||
@@ -627,2 +730,3 @@ - `PENDING_INSTALL`: The error occurred while installing the app. | ||
| #### Enum keys | ||
@@ -636,2 +740,3 @@ | ||
| </div> | ||
@@ -643,3 +748,3 @@ | ||
| The pending operation of the app. Only present if the app's `status` is `PENDING`. | ||
| The pending operation of the app. Only present if the app's `status` is `PENDING`. | ||
@@ -652,2 +757,3 @@ - `INSTALL`: The app is currently being installed. | ||
| #### Enum keys | ||
@@ -661,2 +767,3 @@ | ||
| </div> | ||
@@ -678,2 +785,3 @@ | ||
| #### Enum keys | ||
@@ -687,2 +795,3 @@ | ||
| </div> | ||
@@ -694,14 +803,15 @@ | ||
| The deployment status of the app's sub resource: | ||
| The deployment status of the app's sub resource: | ||
| - `SCHEDULED`: Only the uploaded app bundle is persisted. | ||
| - `DEPLOYING`: The app's sub resources are currently being deployed. | ||
| - `DEPLOYING`: The app's sub resources are currently being deployed. | ||
| - `DEPLOYED`: The app's sub resources were successfully deployed. | ||
| - `DEPLOYED`: The app's sub resources were successfully deployed. | ||
| - `FAILED`: The deployment of the app's sub resources failed. | ||
| - `FAILED`: The deployment of the app's sub resources failed. | ||
| - `NO_RESOURCES`: The app bundle does not contain any sub resources of this type | ||
| #### Enum keys | ||
@@ -715,2 +825,3 @@ | ||
| </div> | ||
@@ -730,2 +841,5 @@ | ||
| - `DOCUMENTS`: documents, e.g. templates, that are part of an app bundle. | ||
| #### Enum keys | ||
@@ -735,6 +849,7 @@ | ||
| `Files` | `Functions` | `SettingsSchemas` | ||
| `Documents` | `Files` | `Functions` | `SettingsSchemas` | ||
| </div> | ||
| </div> |
| { | ||
| "dynagen": { | ||
| "version": "0.13.1", | ||
| "version": "0.13.3", | ||
| "generatedAt": "", | ||
| "template": { | ||
| "name": "@dynatrace-sdk/template-typescript-client", | ||
| "version": "0.18.10" | ||
| "version": "0.18.12" | ||
| } | ||
@@ -12,5 +12,5 @@ }, | ||
| "title": "AppEngine - Registry", | ||
| "version": "1.6.0", | ||
| "version": "1.7.0", | ||
| "baseUrl": "/platform/app-engine/registry/v1" | ||
| } | ||
| } |
@@ -828,11 +828,21 @@ /** | ||
| }; | ||
| var addArrayQueryParam = (query, key) => { | ||
| var addExplodedArrayQueryParam = (query, key) => { | ||
| const arrayValue = query[key]; | ||
| return arrayValue.map((value) => encodeQueryParam(key, value)).join("&"); | ||
| }; | ||
| var addNonExplodedArrayQueryParams = (query, key) => { | ||
| const encodedKey = encodeURIComponent(key); | ||
| const encodedParamsList = query[key].map((value) => encodeURIComponent(typeof value === "number" ? value : String(value))).join(","); | ||
| return `${encodedKey}=${encodedParamsList}`; | ||
| }; | ||
| var addQueryParam = (query, key) => encodeQueryParam(key, query[key]); | ||
| var toQueryString = (rawQuery) => { | ||
| var arrayQueryParams = (query, key, explode) => { | ||
| return explode ? addExplodedArrayQueryParam(query, key) : addNonExplodedArrayQueryParams(query, key); | ||
| }; | ||
| var toQueryString = (rawQuery, flags = {}) => { | ||
| const query = rawQuery || {}; | ||
| const keys = Object.keys(query).filter((key) => typeof query[key] !== "undefined"); | ||
| const queryString = keys.map((key) => Array.isArray(query[key]) ? addArrayQueryParam(query, key) : addQueryParam(query, key)).join("&"); | ||
| const queryString = keys.map( | ||
| (key) => Array.isArray(query[key]) ? arrayQueryParams(query, key, flags.explode?.hasOwnProperty(key) ? flags.explode[key] : true) : addQueryParam(query, key) | ||
| ).join("&"); | ||
| return queryString ? `?${queryString}` : ""; | ||
@@ -1319,2 +1329,3 @@ }; | ||
| SubResourceStatusSubResourceType2["SettingsSchemas"] = "SETTINGS_SCHEMAS"; | ||
| SubResourceStatusSubResourceType2["Documents"] = "DOCUMENTS"; | ||
| return SubResourceStatusSubResourceType2; | ||
@@ -1321,0 +1332,0 @@ })(SubResourceStatusSubResourceType || {}); |
| { | ||
| "name": "@dynatrace-sdk/client-app-engine-registry", | ||
| "version": "1.6.2", | ||
| "version": "1.7.1", | ||
| "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.9" | ||
| "@dynatrace-sdk/http-client": "^1.0.10" | ||
| }, | ||
@@ -11,0 +11,0 @@ "main": "./cjs/index.js", |
809
README.md
| # @dynatrace-sdk/client-app-engine-registry | ||
| [](https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry/v/1.6.2) | ||
| [](https://www.npmjs.com/package/@dynatrace-sdk/client-app-engine-registry/v/1.7.1) | ||
| [](https://opensource.org/licenses/Apache-2.0) | ||
| ## Overview | ||
| The Registry is mainly responsible for | ||
| * installing / updating / storing apps | ||
| * uninstalling / removing apps | ||
| * getting apps | ||
| ### Asynchronous behavior | ||
| Both the install and the uninstall process are performed asynchronously. The Registry persists | ||
| the app bundle and defines the desired state of the app (e.g. installed, uninstalled). The | ||
| installation / uninstallation process is then handled asynchronously by a separate service. | ||
| The Registry is mainly responsible for | ||
| The current status of the app is provided by the status in the response body of the | ||
| respective GET request, e.g. `/apps/{id}`. | ||
| - installing / updating / storing apps | ||
| - uninstalling / removing apps | ||
| - getting apps | ||
| ### Asynchronous behavior | ||
| Both the install and the uninstall process are performed asynchronously. The Registry persists | ||
| the app bundle and defines the desired state of the app (e.g. installed, uninstalled). The | ||
| installation / uninstallation process is then handled asynchronously by a separate service. | ||
| The current status of the app is provided by the status in the response body of the | ||
| respective GET request, e.g. `/apps/{id}`. | ||
| ## Installation | ||
@@ -29,6 +27,3 @@ | ||
| ## API reference | ||
| Full API reference for this SDK is available at [Dynatrace Developer](https://developer.dynatrace.com/reference/sdks/client-app-engine-registry/). | ||
| ## Getting help | ||
@@ -39,4 +34,786 @@ | ||
| ## License | ||
| This SDK is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), see LICENSE for more information. | ||
| # API reference | ||
| Full API reference for the latest version of the SDK is also available at the [Dynatrace Developer](https://developer.dynatrace.com/reference/sdks/client-app-engine-registry/). | ||
| ## appEngineRegistryAppsClient | ||
| ```js | ||
| import { appEngineRegistryAppsClient } from '@dynatrace-sdk/client-app-engine-registry'; | ||
| ``` | ||
| ### getApp | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistryAppsClient.getApp(config): Promise<[AppInfo](#appinfo)></strong> | ||
| <div class="padding-left--md"> | ||
| Get an installed app | ||
| **Required scope:** app-engine:apps:run | ||
| During an app update, when a current version and a new version exists, the current one is returned. | ||
| </div> | ||
| #### Parameters | ||
| | 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> | | ||
| |config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier for the app | | ||
| #### Returns | ||
| OK | ||
| <details> | ||
| <summary> | ||
| Code example | ||
| </summary> | ||
| ```ts | ||
| import { appEngineRegistryAppsClient } from "@dynatrace-sdk/client-app-engine-registry"; | ||
| const data = await appEngineRegistryAppsClient.getApp({ | ||
| id: "...", | ||
| }); | ||
| ``` | ||
| </details> | ||
| </div> | ||
| ### getApps | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistryAppsClient.getApps(config): Promise<[AppInfoList](#appinfolist)></strong> | ||
| <div class="padding-left--md"> | ||
| List all installed apps. | ||
| **Required scope:** app-engine:apps:run | ||
| </div> | ||
| #### Parameters | ||
| | 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> | | ||
| |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>| | ||
| |config.includeDeactivated|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, apps that are <code>DEACTIVATED</code> because of missing entitlements are included in the response. <i>default:</i> <code>false</code>| | ||
| |config.includeNonRunnable|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|If <code>true</code>, apps that the user is not allowed to run because of missing permissions are included in the response. <i>default:</i> <code>false</code>| | ||
| #### Returns | ||
| OK | ||
| <details> | ||
| <summary> | ||
| Code example | ||
| </summary> | ||
| ```ts | ||
| import { appEngineRegistryAppsClient } from "@dynatrace-sdk/client-app-engine-registry"; | ||
| const data = await appEngineRegistryAppsClient.getApps(); | ||
| ``` | ||
| </details> | ||
| </div> | ||
| ### installApp | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistryAppsClient.installApp(config): Promise<[AppStub](#appstub)></strong> | ||
| <div class="padding-left--md"> | ||
| Install or update an app. | ||
| **Required scope:** app-engine:apps:install | ||
| An app ID always starts with a namespace and a dot, e.g. `dynatrace.` for Dynatrace apps. Custom apps can be installed in the `my` namespace, e.g. `my.first-app`. | ||
| *The zipped app bundle has to be provided via the request body* | ||
| </div> | ||
| #### Parameters | ||
| | Name | Type| | ||
| |---|---| | ||
| |config.body<sup>*required</sup>|Blob| | ||
| #### Returns | ||
| Accepted; new app will be installed/updated | ||
| <details> | ||
| <summary> | ||
| Code example | ||
| </summary> | ||
| ```ts | ||
| import { appEngineRegistryAppsClient } from "@dynatrace-sdk/client-app-engine-registry"; | ||
| const data = await appEngineRegistryAppsClient.installApp({ | ||
| body: new Blob(), | ||
| }); | ||
| ``` | ||
| </details> | ||
| </div> | ||
| ### searchActions | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistryAppsClient.searchActions(config): Promise<[SearchAppActionList](#searchappactionlist)></strong> | ||
| <div class="padding-left--md"> | ||
| Search actions of installed apps. | ||
| **Required scope:** app-engine:apps:run | ||
| </div> | ||
| #### Parameters | ||
| | 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> | | ||
| #### Returns | ||
| OK | ||
| <details> | ||
| <summary> | ||
| Code example | ||
| </summary> | ||
| ```ts | ||
| import { appEngineRegistryAppsClient } from "@dynatrace-sdk/client-app-engine-registry"; | ||
| const data = | ||
| await appEngineRegistryAppsClient.searchActions(); | ||
| ``` | ||
| </details> | ||
| </div> | ||
| ### uninstallApp | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistryAppsClient.uninstallApp(config): Promise<void></strong> | ||
| <div class="padding-left--md"> | ||
| Uninstall an app. | ||
| **Required scope:** app-engine:apps:delete | ||
| </div> | ||
| #### Parameters | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |config.id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The unique identifier for the app | | ||
| <details> | ||
| <summary> | ||
| Code example | ||
| </summary> | ||
| ```ts | ||
| import { appEngineRegistryAppsClient } from "@dynatrace-sdk/client-app-engine-registry"; | ||
| const data = await appEngineRegistryAppsClient.uninstallApp( | ||
| { id: "..." }, | ||
| ); | ||
| ``` | ||
| </details> | ||
| </div> | ||
| ## appEngineRegistrySchemaManifestClient | ||
| ```js | ||
| import { appEngineRegistrySchemaManifestClient } from '@dynatrace-sdk/client-app-engine-registry'; | ||
| ``` | ||
| ### getAppManifestSchema | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistrySchemaManifestClient.getAppManifestSchema(abortSignal?): Promise<Record<[string](https://developer.mozilla.org/en-US/docs/Glossary/String) | [any](https://www.typescriptlang.org/docs/handbook/2/everyday-types.html#any)>></strong> | ||
| <div class="padding-left--md"> | ||
| Get JSON schema for app manifests | ||
| </div> | ||
| #### Returns | ||
| OK | ||
| <details> | ||
| <summary> | ||
| Code example | ||
| </summary> | ||
| ```ts | ||
| import { appEngineRegistrySchemaManifestClient } from "@dynatrace-sdk/client-app-engine-registry"; | ||
| const data = | ||
| await appEngineRegistrySchemaManifestClient.getAppManifestSchema(); | ||
| ``` | ||
| </details> | ||
| </div> | ||
| ### getDefaultCspProperties | ||
| <div class="padding-bottom--md"> | ||
| <strong>appEngineRegistrySchemaManifestClient.getDefaultCspProperties(abortSignal?): Promise<[AppDefaultCsp](#appdefaultcsp)></strong> | ||
| <div class="padding-left--md"> | ||
| Get default CSP rules for apps | ||
| </div> | ||
| #### Returns | ||
| OK | ||
| <details> | ||
| <summary> | ||
| Code example | ||
| </summary> | ||
| ```ts | ||
| import { appEngineRegistrySchemaManifestClient } from "@dynatrace-sdk/client-app-engine-registry"; | ||
| const data = | ||
| await appEngineRegistrySchemaManifestClient.getDefaultCspProperties(); | ||
| ``` | ||
| </details> | ||
| </div> | ||
| ## Types | ||
| ### AppDefaultCsp | ||
| Default Content Security Policies for apps. | ||
| | Name | Type| | ||
| |---|---| | ||
| |policyDirectives<sup>*required</sup>|[AppDefaultCspPolicyDirectives](#appdefaultcsppolicydirectives)| | ||
| ### AppDefaultCspPolicyDirectives | ||
| The policy directives | ||
| ### AppIcon | ||
| Representation of an app icon. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |href<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The reference to an app icon | | ||
| ### AppInfo | ||
| A minimal representation of an app. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |appIcon|[AppIcon](#appicon)| | | ||
| |description<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The description of the app | | ||
| |id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The id of the app | | ||
| |isBuiltin|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|<p>Whether this is a built-in app or not. Built-in apps are provided by Dynatrace and installed on every environment.</p> | | ||
| |isolatedUri|[AppIsolatedUri](#appisolateduri)| | | ||
| |manifest|AppInfoManifest| | | ||
| |modificationInfo<sup>*required</sup>|[ModificationInfo](#modificationinfo)| | | ||
| |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The name of the app | | ||
| |resourceContext|[ResourceContext](#resourcecontext)| | | ||
| |resourceStatus<sup>*required</sup>|[ResourceStatus](#resourcestatus)| | | ||
| |signatureInfo<sup>*required</sup>|[AppSignatureInfo](#appsignatureinfo)| | | ||
| |version<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The version of the app | | ||
| ### AppInfoList | ||
| A list of minimal app representations. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |apps<sup>*required</sup>|Array<[AppInfo](#appinfo)>|The list of minimal app representations. | | ||
| ### AppIsolatedUri | ||
| Representation of an app's isolated uri. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |baseUrl<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The base URL of an app | | ||
| |url<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The URL of an app | | ||
| |widgetUrl<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The base URL for widgets of an app | | ||
| ### AppSignatureInfo | ||
| Representation of an app's signature verification. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |publisher|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The organization name of the app publisher. | | ||
| |signed<sup>*required</sup>|[boolean](https://developer.mozilla.org/en-US/docs/Glossary/Boolean)|App is signed and its signature has been verified. | | ||
| ### AppStub | ||
| A minimal representation of an installed/updated app. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Id of the installed/updated app | | ||
| |warnings|Array<[Warning](#warning)>|Contains warning information although the request was successful | | ||
| ### ConstraintViolation | ||
| Contains information about a constraint violation caused by invalid input. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message | | ||
| |path<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The path of the property that caused the constraint violation | | ||
| ### Error | ||
| Contains information for 4xx and 5xx errors. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |code<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|The HTTP status code | | ||
| |details|[ErrorDetails](#errordetails)| | | ||
| |help|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Additional information related to the error | | ||
| |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message | | ||
| |retryAfterSeconds|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Seconds to wait until the next retry | | ||
| ### ErrorDetails | ||
| Contains details for 4xx and 5xx errors. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |constraintViolations|Array<[ConstraintViolation](#constraintviolation)>|A list of constraint violations | | ||
| |errorCode|MaxNumberOfInstalledCustomAppsExceeded| | | ||
| |errorCodeProperties|[ErrorDetailsErrorCodeProperties](#errordetailserrorcodeproperties)| | | ||
| |errorRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Generated unique value for 5xx errors. | | ||
| |traceId|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|OpenTelemetry trace id of the trace where error occurs. | | ||
| ### ErrorDetailsErrorCodeProperties | ||
| Additional properties related to the provided error code | ||
| | 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 | | ||
| ### ErrorEnvelope | ||
| Error response for all 4xx and 5xx errors. | ||
| | Name | Type| | ||
| |---|---| | ||
| |error<sup>*required</sup>|[Error](#error)| | ||
| ### ModificationInfo | ||
| Modification information about the app | ||
| | 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') | | ||
| |createdBy<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|UserId of the user that created the resource | | ||
| |lastModifiedAt<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Timestamp when the resource was last modified in ISO 8601 format (yyyy-MM-dd'T'HH:mm:ss.SSS'Z') | | ||
| |lastModifiedBy<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|UserId of the user that last modified the resource | | ||
| ### ResourceContext | ||
| Additional resource context information | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |operations|Array<ResourceContextOperationsItem>|<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> | | ||
| ### ResourceStatus | ||
| The status of the app plus additional details. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |operationStateBeforeError|ResourceStatusOperationStateBeforeError| | | ||
| |pendingOperation|ResourceStatusPendingOperation| | | ||
| |status<sup>*required</sup>|ResourceStatusStatus| | | ||
| |subResourceStatuses|Array<[SubResourceStatus](#subresourcestatus)>|The statuses of the app's sub resources. | | ||
| ### SearchAppAction | ||
| List of apps with actions. Apps are sorted by name in ascending order. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |actions<sup>*required</sup>|Array<SearchAppActionActionsItem>|List of app actions. Actions are sorted by name in ascending order. Actions without name are last. | | ||
| |id<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|App id | | ||
| |name<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|App name | | ||
| ### SearchAppActionList | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |apps<sup>*required</sup>|Array<[SearchAppAction](#searchappaction)>| | | ||
| |totalCount<sup>*required</sup>|[number](https://developer.mozilla.org/en-US/docs/Glossary/Number)|Total actions count. | | ||
| ### SubResourceConstraintViolation | ||
| Contains information about a constraint violation caused by invalid input. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message | | ||
| |path|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The path of the property that caused the constraint violation | | ||
| ### SubResourceError | ||
| Additional error information that can be present if the sub resource `status` is `FAILED` | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |constraintViolations|Array<[SubResourceConstraintViolation](#subresourceconstraintviolation)>|A list of constraint violations | | ||
| |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. | | ||
| |errorRef|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|Optional generated unique value to reference this error. | | ||
| |message<sup>*required</sup>|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The error message. | | ||
| ### SubResourceStatus | ||
| The status of the sub resource. | ||
| | Name | Type| | ||
| |---|---| | ||
| |error|[SubResourceError](#subresourceerror)| | ||
| |status<sup>*required</sup>|SubResourceStatusStatus| | ||
| |subResourceType<sup>*required</sup>|SubResourceStatusSubResourceType| | ||
| ### Warning | ||
| A warning. | ||
| | Name | Type| Description| | ||
| |---|---|---| | ||
| |message|[string](https://developer.mozilla.org/en-US/docs/Glossary/String)|The warning message. | | ||
| ## Enums | ||
| ### ErrorDetailsErrorCode | ||
| <div class="padding-left--md"> | ||
| An optional error code that contains more detailed error information than the HTTP response code alone. | ||
| Possible error codes: | ||
| * `MaxNumberOfInstalledCustomAppsExceeded`: The app bundle could not be uploaded because the max number of custom apps was exceeded. Learn more: https://dt-url.net/upgrade-license | ||
| #### Enum keys | ||
| <div class="padding-left--md"> | ||
| `MaxNumberOfInstalledCustomAppsExceeded` | ||
| </div> | ||
| </div> | ||
| ### ResourceContextOperationsItem | ||
| <div class="padding-left--md"> | ||
| #### Enum keys | ||
| <div class="padding-left--md"> | ||
| `Run` | `Uninstall` | `Update` | ||
| </div> | ||
| </div> | ||
| ### ResourceStatusOperationStateBeforeError | ||
| <div class="padding-left--md"> | ||
| Details about the state when an error occurred. Only present if the app's `status` is `ERROR`. | ||
| - `PENDING_INSTALL`: The error occurred while installing the app. | ||
| - `PENDING_UPDATE`: The error occurred while updating the app. | ||
| - `PENDING_DELETE`: The error occurred while deleting the app. | ||
| - `OK`: At least one sub resource failed while the app was already running. | ||
| #### Enum keys | ||
| <div class="padding-left--md"> | ||
| `Ok` | `PendingDelete` | `PendingInstall` | `PendingUpdate` | ||
| </div> | ||
| </div> | ||
| ### ResourceStatusPendingOperation | ||
| <div class="padding-left--md"> | ||
| The pending operation of the app. Only present if the app's `status` is `PENDING`. | ||
| - `INSTALL`: The app is currently being installed. | ||
| - `UPDATE`: The app is currently being updated. | ||
| - `DELETE`: The app is currently being deleted. | ||
| #### Enum keys | ||
| <div class="padding-left--md"> | ||
| `Delete` | `Install` | `Update` | ||
| </div> | ||
| </div> | ||
| ### ResourceStatusStatus | ||
| <div class="padding-left--md"> | ||
| The status of the app. | ||
| - `OK`: The app is fully installed and running. | ||
| - `PENDING`: The app is currently being installed, updated or deleted. | ||
| - `DEACTIVATED`: The app is deactivated and cannot be executed. | ||
| - `ERROR`: The app failed with an error. | ||
| #### Enum keys | ||
| <div class="padding-left--md"> | ||
| `Deactivated` | `Error` | `Ok` | `Pending` | ||
| </div> | ||
| </div> | ||
| ### SubResourceStatusStatus | ||
| <div class="padding-left--md"> | ||
| The deployment status of the app's sub resource: | ||
| - `SCHEDULED`: Only the uploaded app bundle is persisted. | ||
| - `DEPLOYING`: The app's sub resources are currently being deployed. | ||
| - `DEPLOYED`: The app's sub resources were successfully deployed. | ||
| - `FAILED`: The deployment of the app's sub resources failed. | ||
| - `NO_RESOURCES`: The app bundle does not contain any sub resources of this type | ||
| #### Enum keys | ||
| <div class="padding-left--md"> | ||
| `Deployed` | `Deploying` | `Failed` | `NoResources` | `Scheduled` | ||
| </div> | ||
| </div> | ||
| ### SubResourceStatusSubResourceType | ||
| <div class="padding-left--md"> | ||
| The sub resource type. | ||
| - `FUNCTIONS`: app functions. | ||
| - `FILES`: static files of an app. | ||
| - `SETTINGS_SCHEMAS`: settings schemas of an app. | ||
| - `DOCUMENTS`: documents, e.g. templates, that are part of an app bundle. | ||
| #### Enum keys | ||
| <div class="padding-left--md"> | ||
| `Documents` | `Files` | `Functions` | `SettingsSchemas` | ||
| </div> | ||
| </div> |
@@ -87,3 +87,4 @@ import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client'; | ||
| * 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. | ||
| * For an action to match, each search term must be contained in either: app name, app description, | ||
| * action name or action description. | ||
| * | ||
@@ -90,0 +91,0 @@ * Search terms are case insensitive and each additional search term restricts actions further. |
@@ -6,2 +6,3 @@ /** | ||
| * - `SETTINGS_SCHEMAS`: settings schemas of an app.<br> | ||
| * - `DOCUMENTS`: documents, e.g. templates, that are part of an app bundle.<br> | ||
| */ | ||
@@ -11,3 +12,4 @@ export declare enum SubResourceStatusSubResourceType { | ||
| Files = "FILES", | ||
| SettingsSchemas = "SETTINGS_SCHEMAS" | ||
| SettingsSchemas = "SETTINGS_SCHEMAS", | ||
| Documents = "DOCUMENTS" | ||
| } |
| declare type QueryParamsType = Record<string | number, any>; | ||
| export declare const toQueryString: (rawQuery?: QueryParamsType) => string; | ||
| interface ParametersFlags { | ||
| explode?: Record<string, boolean>; | ||
| } | ||
| export declare const toQueryString: (rawQuery?: QueryParamsType, flags?: ParametersFlags) => string; | ||
| export {}; |
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 by3.51%
213001
- Lines of code
- increased by0.66%
4280
- Number of lines in readme file
- increased by1895.12%
818