@dynatrace-sdk/client-query 1.2.0 → 1.2.2

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (7) hide show
  1. package/CHANGELOG.md +21 -8
  2. package/README.md +12 -41
  3. package/docs/DOCS.md +237 -801
  4. package/dynatrace-metadata.json +2 -5
  5. package/package.json +1 -1
  6. package/types/packages/client/query/src/lib/apis/query-assistance-api.d.ts +27 -0
  7. package/types/packages/client/query/src/lib/apis/query-execution-api.d.ts +28 -0
package/CHANGELOG.md CHANGED
@@ -2,17 +2,30 @@
2
2
 
3
3
  @dynatrace-sdk/client-query
4
4
 
5
+ ## 1.2.2
6
+
7
+ ### Patch Changes
8
+
9
+ - Update docs.
10
+
11
+ ## 1.2.1
12
+
13
+ ### Patch Changes
14
+
15
+ - Add JSDoc @example for operations.
16
+ - Fix handling of the application/cloudevent+json content type.
17
+
5
18
  ## 1.2.0
6
19
 
7
20
  ### Minor Changes
8
21
 
9
- - 88696f56: Add `sampled` property to GrailMetadata
22
+ - Add `sampled` property to GrailMetadata
10
23
 
11
24
  ## 1.1.0
12
25
 
13
26
  ### Minor Changes
14
27
 
15
- - 6aca01cb: Export model transformations
28
+ - Export model transformations
16
29
 
17
30
  ## 1.0.6
18
31
 
@@ -25,14 +38,14 @@
25
38
 
26
39
  ### Patch Changes
27
40
 
28
- - dfc1b337: Update `@dynatrace-sdk/http-client` to `^1.0.1`
29
- - dfc1b337: Use parsed response body in error serializer
41
+ - Update `@dynatrace-sdk/http-client` to `^1.0.1`
42
+ - Use parsed response body in error serializer
30
43
 
31
44
  ## 1.0.4
32
45
 
33
46
  ### Patch Changes
34
47
 
35
- - 39f914be: Send response body in error serializer
48
+ - Send response body in error serializer
36
49
  - Updated dependencies
37
50
  - @dynatrace-sdk/http-client@1.0.0
38
51
 
@@ -40,13 +53,13 @@
40
53
 
41
54
  ### Patch Changes
42
55
 
43
- - ccfbe457: Updated descriptions and examples.
56
+ - Updated descriptions and examples.
44
57
 
45
58
  ## 1.0.2
46
59
 
47
60
  ### Patch Changes
48
61
 
49
- - f225ca89: Generate client package with template-typescript-client v0.13.10. Query question mark is now removed from url when there are no search params.
62
+ - Generate client package with template-typescript-client v0.13.10. Query question mark is now removed from url when there are no search params.
50
63
 
51
64
  ## 1.0.1
52
65
 
@@ -62,4 +75,4 @@
62
75
 
63
76
  ### Major Changes
64
77
 
65
- - dbca1de4: Initial release of @dynatrace-sdk/client-query.
78
+ - Initial release of @dynatrace-sdk/client-query.
package/README.md CHANGED
@@ -1,54 +1,25 @@
1
- # Storage – Query Service
2
- API version: `1.1.0`.
1
+ # @dynatrace-sdk/client-query
3
2
 
3
+ [![npm](https://img.shields.io/badge/npm-v1.2.2-blue)](https://www.npmjs.com/package/@dynatrace-sdk/client-query/v/1.2.2)
4
+ [![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](https://opensource.org/licenses/Apache-2.0)
4
5
 
5
-
6
-
7
- Exposes an API to fetch records stored in Grail
6
+ Exposes an API to fetch records stored in Grail
8
7
 
9
8
  ## Installation
10
9
 
11
- ```
10
+ ```bash
12
11
  npm install @dynatrace-sdk/client-query
13
12
  ```
14
13
 
15
- > **Important!** The content of this library is autogenerated.
16
-
17
- ## [Experimental] Using client in nodejs/jest environment
18
-
19
- > **Important!** Node.js officially is not supported. This guide shows some workarounds to enable usage of the client in nodejs runtime.
20
-
21
- There is a possibility to use SDK clients in nodejs runtime. This may require additional setup:
22
- First, developer may need to polyfill `fetch` function with some library like [undici](https://github.com/nodejs/undici) or [node-fetch](https://github.com/node-fetch/node-fetch).
23
- Then, developer would need to provide the implementation of [HttpClient](https://bitbucket.lab.dynatrace.org/projects/APPFW/repos/dynatrace-sdk/browse/packages/http-client/src/lib/types/http-client.ts) interface. Sample code to achieve this:
24
- ```typescript
25
- import { PlatformHttpClientResponse } from '@dynatrace-sdk/http-client';
26
- import { fetch } from 'undici';
27
-
28
- const myHttpClient = {
29
- async send(options: any) {
30
- return new PlatformHttpClientResponse(
31
- await (fetch(`http://localhost:3000${options.url}`, { // here we would need to patch the request url to include hostname.
32
- method: options.method,
33
- headers: options.headers,
34
- signal: options.abortSignal,
35
- body: JSON.stringify(options.body), // but this will not work for form-data content-type
36
- }) as any),
37
- );
38
- },
39
- };
40
- ```
14
+ ## API reference
41
15
 
42
- Then, once we have the instance of custom http client, we may instantiate the API Client instance:
16
+ Full API reference for this SDK is available at [Dynatrace Developer](https://developer.dynatrace.com/reference/sdks/client-query/).
43
17
 
44
- ```typescript
45
- import {
46
- SettingsObjectsClient,
47
- } from '@dynatrace-sdk/client-example';
18
+ ## Getting help
48
19
 
49
- // ...
20
+ - Visit [SDK for Typescript](https://developer.dynatrace.com/reference/sdks/) guide in the [Dynatrace Developer](https://developer.dynatrace.com/)
21
+ - Ask a question in the [Dynatrace Community](https://community.dynatrace.com/)
50
22
 
51
- const settingsObjectsClient = new SettingsObjectsClient(myHttpClient);
23
+ ## License
52
24
 
53
- const settings = await settingsObjectsClient.getSettings({});
54
- ```
25
+ This SDK is distributed under the [Apache License, Version 2.0](http://www.apache.org/licenses/LICENSE-2.0), see LICENSE for more information.