Skip to content

Commit 707df15

Browse files
2.10.0 (#177)
* updates upload * Version3 updates * telemetry metadata removed * crlf -> lf * Service Desk API (#174) * initial service desk api code uploading * reverting agile changes * improvements * JSDoc improvements * Tests enabled in CI * Maxworkers removed from integration tests * updates * timeout moved * timeout moved * test fixes * lint fix * readme updated * service desk added to index
1 parent 3ebad9e commit 707df15

File tree

200 files changed

+5717
-651
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

200 files changed

+5717
-651
lines changed

.github/workflows/ci.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,8 @@ jobs:
2626
echo EMAIL=${{ secrets.EMAIL }} >> .env
2727
echo API_TOKEN=${{ secrets.API_TOKEN }} >> .env
2828
- run: npm run build
29-
# - run: npm run test:unit
30-
# - run: npm run test:integration
29+
- run: npm run test:unit
30+
- run: npm run test:integration
3131
- run: npm run lint
3232
env:
3333
CI: true

CHANGELOG.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,9 @@
11
# Jira.js changelog
22

3+
### 2.10.0
4+
5+
- [Service Desk API](https://developer.atlassian.com/cloud/jira/service-desk/rest/intro/) added
6+
37
### 2.9.0
48

59
- Telemetry removed (deprecated).

README.md

Lines changed: 9 additions & 45 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,6 @@ Usability, consistency, and performance are key focuses of jira.js, and it also
1818
## Table of contents
1919

2020
- [Installation](#installation)
21-
- [Telemetry information collection agreement](#telemetry-information-collection-agreement)
22-
- [Customizing telemetry collection data example](#customizing-telemetry-collection-data-example)
23-
- [Disabling telemetry collection example](#disabling-telemetry-collection-example)
2421
- [Usage](#usage)
2522
- [Authentication](#authentication)
2623
- [Basic](#basic-authenticationhttpsdeveloperatlassiancomcloudjiraplatformbasic-auth-for-rest-apis)
@@ -48,48 +45,6 @@ Install with the yarn:
4845
yarn add jira.js
4946
```
5047

51-
## Telemetry information collection agreement
52-
53-
The use of this library may collect, record and transmit data about the operation of the library and related data, as well as potentially personal data, including ip address from which the request is made, user agent from the device from which the request is made, version of the library used, version of the telemetry sending library, name of the invoked method, authorization type information (can be configured), base configuration request usage information, callback information, onResponse middleware usage information, onError middleware usage information, queries usage information, body usage information in request, headers usage information in request, strict GDPR flag enabling information, HTTP response code (can be configured), request start date and time and response receipt date and time (can be configured), No check atlassian token flag enabling information.
54-
55-
The type and amount of data may vary with the version of the libraries and can be changed at any time without notice.
56-
57-
Telemetry data collection is enabled by default.
58-
59-
The following tracking parameters can be configured:
60-
61-
- Authentication type
62-
- Request status code
63-
- Request timings
64-
65-
#### Customizing telemetry collection data example
66-
67-
```typescript
68-
import { Config } from 'jira.js';
69-
70-
const config: Config = {
71-
host: 'https://your-domain.atlassian.net',
72-
telemetry: {
73-
allowedToPassAuthenticationType: false, // true by default
74-
allowedToPassRequestStatusCode: true, // true by default
75-
allowedToPassRequestTimings: false, // true by default
76-
},
77-
};
78-
```
79-
80-
If you want to disable telemetry, set the `telemetry` field to `false`.
81-
82-
#### Disabling telemetry collection example
83-
84-
```typescript
85-
import { Config } from 'jira.js';
86-
87-
const config: Config = {
88-
host: 'https://your-domain.atlassian.net',
89-
telemetry: false, // Telemetry will not be collected
90-
};
91-
```
92-
9348
## Usage
9449

9550
#### Authentication
@@ -417,6 +372,15 @@ Available groups:
417372
- [workflowTransitionProperties](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-workflow-transition-properties/#api-group-workflow-transition-properties)
418373
- [appProperties](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-app-properties/#api-group-app-properties)
419374
- [dynamicModules](https://developer.atlassian.com/cloud/jira/platform/rest/v3/api-group-dynamic-modules/#api-group-dynamic-modules)
375+
- Service desk group:
376+
- [customer](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-customer/)
377+
- [info](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-info/#api-group-info)
378+
- [insight](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-insight/#api-group-insight)
379+
- [knowledgeBase](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-knowledgebase/#api-group-knowledgebase)
380+
- [organizations](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-organization/#api-group-organization)
381+
- [request](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-request/#api-group-request)
382+
- [requestType](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-requesttype/#api-group-requesttype)
383+
- [serviceDesk](https://developer.atlassian.com/cloud/jira/service-desk/rest/api-group-servicedesk/#api-group-servicedesk)
420384

421385
The name of the methods is the name of the endpoint in the group without spaces and in `camelCase`.
422386

0 commit comments

Comments
 (0)