Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# Changelog

### 1.3.0

- Telemetry removed (deprecated)
- Fixed bug with spaceKeys in `client.space.getSpaces` ([#14](https://github.com/MrRefactoring/confluence.js/issues/14) Thanks [David Sanchez](https://github.com/emulienfou) for catching)
- Fixed bug with attachment download ([#15](https://github.com/MrRefactoring/confluence.js/issues/15) Thanks [Martin Reinhardt](https://github.com/hypery2k) for catching)

### 1.2.2

- JSDOC improvements
Expand Down
57 changes: 0 additions & 57 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,9 +18,6 @@ Usability, consistency, and performance are key focuses of confluence.js, and it
## Table of contents

- [Installation](#installation)
- [Telemetry information collection agreement](#telemetry-information-collection-agreement)
- [Customizing telemetry collection data example](#customizing-telemetry-collection-data-example)
- [Disabling telemetry collection example](#disabling-telemetry-collection-example)
- [Usage](#usage)
- [Authentication](#authentication)
- [Basic](#basic-authenticationhttpsdeveloperatlassiancomcloudconfluencebasic-auth-for-rest-apis)
Expand All @@ -47,60 +44,6 @@ Install with the yarn:
yarn add confluence.js
```

## Telemetry information collecting agreement

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, 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.

The type and amount of data may vary with the version of the libraries and can be changed at any time without notice.

Telemetry data collection is enabled by default.

The following tracking parameters can be configured:

- Authentication type
- Request status code
- Request timings

#### Customizing telemetry collecting data example

```typescript
import { Config } from 'confluence.js';

const config: Config = {
host: 'https://your-domain.atlassian.net',
telemetry: {
allowedToPassAuthenticationType: false, // true by default
allowedToPassRequestStatusCode: true, // true by default
allowedToPassRequestTimings: false, // true by default
},
};
```

If you want to disable telemetry, set the `telemetry` field to `false`.

#### Disabling telemetry collection example

```typescript
import { Config } from 'confluence.js';

const config: Config = {
host: 'https://your-domain.atlassian.net',
telemetry: false, // Telemetry will not be collected
};
```

## Usage

#### Authentication
Expand Down
Loading