@dynatrace-sdk/client-query 1.2.0 → 1.2.2

package/dynatrace-metadata.json

@@ -1,10 +1,10 @@
 {
   "dynagen": {
-    "version": "0.10.8",
+    "version": "0.10.9",
     "generatedAt": "",
     "template": {
       "name": "@dynatrace-sdk/template-typescript-client",
-      "version": "0.17.0"
+      "version": "0.17.4"
     },
     "featureFlags": {
       "typeguards": true
@@ -14,8 +14,5 @@
     "title": "Storage – Query Service",
     "version": "1.1.0",
     "baseUrl": "/platform/storage/query/v1"
-  },
-  "docs": {
-    "title": "Storage – Query Service"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dynatrace-sdk/client-query",
-  "version": "1.2.0",
+  "version": "1.2.2",
   "dependencies": {
     "@dynatrace-sdk/http-client": "^1.0.3"
   },

package/types/packages/client/query/src/lib/apis/query-assistance-api.d.ts

@@ -25,7 +25,16 @@ export declare class QueryAssistanceClient {
      *
      * Verifies the supplied query string and other query parameters for lack of any errors, but without actually
      * submitting the query for execution.
+     *
      * @returns Supplied query and parameters were verified.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryAssistanceClient.queryVerify({
+     *   authorization: "...",
+     *   body: {} as VerifyRequest,
+     * });
      */
     queryVerify(config: {
         body: VerifyRequest;
@@ -226,7 +235,16 @@ export declare class QueryAssistanceClient {
      * * `INFO` is present: usually if `CANONICAL` is not present (e.g. the parameter key for `FILTER a == 1`), there is an info node
      *   for `FILTER condition:a == 1`. This `condition:` was neither written by the user nor is it canonical; but it might be
      *   used to help the user understand what this parameter means.
+     *
      * @returns A node containing more nodes,  a node offering different (semantically equivalent) versions of the query parts, or a terminal node that shows the canonical form.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryAssistanceClient.queryParse({
+     *   authorization: "...",
+     *   body: {} as ParseRequest,
+     * });
      */
     queryParse(config: {
         body: ParseRequest;
@@ -271,7 +289,16 @@ export declare class QueryAssistanceClient {
      *
      * The `type` helps to treat specific parts of the suggestion different to others; either by a different visualization,
      * a link to docs, etc.
+     *
      * @returns A list of structured autocomplete suggestions.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryAssistanceClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryAssistanceClient.queryAutocomplete({
+     *   authorization: "...",
+     *   body: {} as AutocompleteRequest,
+     * });
      */
     queryAutocomplete(config: {
         body: AutocompleteRequest;

package/types/packages/client/query/src/lib/apis/query-execution-api.d.ts

@@ -48,7 +48,17 @@ export declare class QueryExecutionClient {
      * the new record field types will be placed.
      * It is guaranteed that every field of every record will have a corresponding type.
      * **Clients should always take the included types into account when consuming records!**
+     *
      * @returns The current status and results of the supplied query.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryExecutionClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryExecutionClient.queryPoll({
+     *   requestToken: "...",
+     *   requestTimeoutMilliseconds: 60,
+     *   enrich: "metric-metadata",
+     * });
      */
     queryPoll(config: {
         /** The request-token of the query. */ requestToken: string;
@@ -94,7 +104,17 @@ export declare class QueryExecutionClient {
      * the new record field types will be placed.
      * It is guaranteed that every field of every record will have a corresponding type.
      * **Clients should always take the included types into account when consuming records!**
+     *
      * @returns The final status and results of the supplied query if it finished within a supplied requestTimeoutMilliseconds. | The status of the query to start.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryExecutionClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryExecutionClient.queryExecute({
+     *   enrich: "metric-metadata",
+     *   authorization: "...",
+     *   body: {} as ExecuteRequest,
+     * });
      */
     queryExecute(config: {
         body: ExecuteRequest;
@@ -139,7 +159,15 @@ export declare class QueryExecutionClient {
      * the new record field types will be placed.
      * It is guaranteed that every field of every record will have a corresponding type.
      * **Clients should always take the included types into account when consuming records!**
+     *
      * @returns The query already finished.
+     *
+     * @example <caption>Code example</caption>
+     * import { queryExecutionClient } from "@dynatrace-sdk/client-query";
+     *
+     * const data = await queryExecutionClient.queryCancel({
+     *   requestToken: "...",
+     * });
      */
     queryCancel(config: {
         /** The request-token of the query. */ requestToken: string;